-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A Unicode text type, optimized for low memory overhead
--   
--   A Unicode text type, optimized for low memory overhead. No string
--   manipulation functions are offered.
--   
--   Equality and ordinal comparison aim to be competitive with the Text
--   type.
@package smallstring
@version 0.3.1


-- | An immutable Unicode text type, optimized for low memory overhead. A
--   <a>SmallString</a> typically uses less memory than the corresponding
--   <a>Text</a>. Use <a>SmallString</a> when storing a large number of
--   short texts, for example when indexing a map using words or short
--   phrases.
--   
--   To manipulate a <a>SmallString</a>, first convert it into a
--   <a>Text</a>. For more information on working with <a>Text</a>, see the
--   <tt>text</tt> package:
--   http:<i></i>hackage.haskell.org<i>package</i>text
--   
--   The Ord instance is not guaranteed to be the same as that of the
--   corresponding string.
module Data.SmallString

-- | A space efficient representation of Unicode text.
data SmallString

-- | Convert a <a>String</a> into a <a>SmallString</a>.
fromString :: String -> SmallString

-- | Convert a <a>SmallString</a> into a <a>String</a>.
toString :: SmallString -> String

-- | Convert a <a>Text</a> into a <a>SmallString</a>.
fromText :: Text -> SmallString

-- | Convert a <a>SmallString</a> into a <a>Text</a>.
toText :: SmallString -> Text
instance Hashable SmallString
instance IsString SmallString
instance NFData SmallString
instance Show SmallString
instance Ord SmallString
instance Eq SmallString