Contents

module Spotify
  # A UTF-8 FFI type, making sure all strings are UTF8 in and out.
  #
  # Given an ingoing (ruby to C) string, it will make sure the string
  # is in UTF-8 encoding. An outgoing (C to Ruby) will be assumed to
  # actually be in UTF-8, and force-encoded as such.
  module UTF8String
    extend FFI::DataConverter
    native_type FFI::Type::STRING

    if "".respond_to?(:encode)
      # Given a value, encodes it to UTF-8 no matter what.
      #
      # @note if the value is already in UTF-8, ruby does nothing
      # @note if the given value is falsy, default behaviour is used
      #
      # @param [String] value
      # @param ctx
      # @return [String] value, but in UTF-8 if it wasn’t already
      def self.to_native(value, ctx)
        if value
          value.encode('UTF-8')
        else
          super
        end
      end
    end

    if "".respond_to?(:force_encoding)
      # Given an original string, assume it is in UTF-8.
      #
      # @note NO error checking is made, the string is just forced to UTF-8
      # @param [String] value can be in any encoding
      # @param ctx
      # @return [String] value, but with UTF-8 encoding
      def self.from_native(value, ctx)
        if value
          value.force_encoding('UTF-8')
        else
          super
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
spotify-12.2.0	lib/spotify/types/utf8_string.rb
spotify-12.0.3	lib/spotify/types/utf8_string.rb
spotify-12.0.2	lib/spotify/types/utf8_string.rb
spotify-12.0.1	lib/spotify/types/utf8_string.rb