https://github.com/ruby/iconv

iconv wrapper
https://github.com/ruby/iconv

c hacktoberfest iconv ruby

Last synced: 5 days ago
JSON representation

iconv wrapper

• Host: GitHub
• URL: https://github.com/ruby/iconv
• Owner: ruby
• License: other
• Created: 2013-02-14T06:38:57.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-09-12T08:21:19.000Z (4 months ago)
• Last Synced: 2024-12-29T06:03:51.561Z (12 days ago)
• Topics: c, hacktoberfest, iconv, ruby
• Language: C
• Homepage:
• Size: 67.4 KB
• Stars: 54
• Watchers: 33
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Iconv

[![Build Status](https://travis-ci.org/ruby/iconv.svg)](https://travis-ci.org/ruby/iconv)

iconv wrapper, used to be ext/iconv

## Abstract

Iconv is a wrapper class for the UNIX 95 iconv() function family,

which translates string between various encoding systems.

See Open Group's on-line documents for more details.

* iconv.h:       http://www.opengroup.org/onlinepubs/007908799/xsh/iconv.h.html

* iconv_open():  http://www.opengroup.org/onlinepubs/007908799/xsh/iconv_open.html

* iconv():       http://www.opengroup.org/onlinepubs/007908799/xsh/iconv.html

* iconv_close(): http://www.opengroup.org/onlinepubs/007908799/xsh/iconv_close.html

Which coding systems are available is platform-dependent.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'iconv'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install iconv

## Usage

1. Simple conversion between two charsets.

    ```ruby

    converted_text = Iconv.conv('iso-8859-15', 'utf-8', text)

    ```

2. Instantiate a new `Iconv` and use method `Iconv#iconv`.

    ```ruby

     cd = Iconv.new(to, from)

     begin

       input.each { |s| output << cd.iconv(s) }

       output << cd.iconv(nil)                   # Don't forget this!

     ensure

       cd.close

     end

    ```

3. Invoke `Iconv.open` with a block.

    ```ruby

     Iconv.open(to, from) do |cd|

       input.each { |s| output << cd.iconv(s) }

       output << cd.iconv(nil)

     end

    ```

4. Shorthand for (3).

    ```ruby

     Iconv.iconv(to, from, *input.to_a)

    ```

## Attentions

Even if some extensions of implementation dependent are useful,

DON'T USE those extensions in libraries and scripts to widely distribute.

If you want to use those feature, use `String#encode`.

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## License

Ruby License/2-clause BSDL