MULTI_BYTE_TEXT.String

Enclosing Modules:

MULTI_BYTE_TEXT

structure String :
sig
  include MULTI_BYTE_STRING
  val decodeBytesSlice : codec -> Word8VectorSlice.slice -> string
  val decodeBytes : codec -> Word8Vector.vector -> string
  val decodeString : codec -> String.string -> string
  val getCodec : string -> codec
end

       

Value detail

decodeBytesSlice

fun decodeBytesSlice codec slice : codec -> Word8VectorSlice.slice -> string

decodes a byte vector slice into a multibyte string.

Parameters:

codec

codec

slice

a byte vector slice

decodeBytes

fun decodeBytes codec bytes : codec -> Word8Vector.vector -> string

decodes a byte vector into a multibyte string.

This is equivalent to

   (decodeBytesSlice codec) o Word8VectorSlice.full
 

Parameters:

codec

codec

bytes

a byte vector

decodeString

fun decodeString codec bytes : codec -> String.string -> string

decodes a Basis string into a multibyte string.

This is equivalent to

   (decodeBytes codec) o Byte.stringToBytes
 

Parameters:

codec

codec

bytes

a byte vector

getCodec

fun getCodec string : string -> codec

returns the codec used to decode the string.

Parameters:

string

a multibyte string.