var searchIndex = {};
searchIndex["encoding_rs"] = {"doc":"encoding_rs is a Gecko-oriented Free Software / Open Source implementation\nof the [Encoding Standard](https://encoding.spec.whatwg.org/) in Rust.\nGecko-oriented means that converting to and from UTF-16 is supported in\naddition to converting to and from UTF-8 and that the performance and\nstreamability goals are browser-oriented.","items":[[3,"Encoding","encoding_rs","An encoding as defined in the\n[Encoding Standard](https://encoding.spec.whatwg.org/).",null,null],[3,"Decoder","","A converter that decodes a byte stream into Unicode according to a\ncharacter encoding in a streaming (incremental) manner.",null,null],[3,"Encoder","","A converter that encodes a Unicode stream into bytes according to a\ncharacter encoding in a streaming (incremental) manner.",null,null],[4,"CoderResult","","Result of a (potentially partial) decode or encode operation with\nreplacement.",null,null],[13,"InputEmpty","","The input was exhausted.",0,null],[13,"OutputFull","","The converter cannot produce another unit of output, because the output\nbuffer does not have enough space left.",0,null],[4,"DecoderResult","","Result of a (potentially partial) decode operation without replacement.",null,null],[13,"InputEmpty","","The input was exhausted.",1,null],[13,"OutputFull","","The decoder cannot produce another unit of output, because the output\nbuffer does not have enough space left.",1,null],[13,"Malformed","","The decoder encountered a malformed byte sequence.",1,null],[4,"EncoderResult","","Result of a (potentially partial) encode operation without replacement.",null,null],[13,"InputEmpty","","The input was exhausted.",2,null],[13,"OutputFull","","The encoder cannot produce another unit of output, because the output\nbuffer does not have enough space left.",2,null],[13,"Unmappable","","The encoder encountered an unmappable character.",2,null],[0,"ffi","","",null,null],[3,"ConstEncoding","encoding_rs::ffi","Newtype for `*const Encoding` in order to be able to implement `Sync` for\nit.",null,null],[5,"encoding_for_label","","",null,null],[5,"encoding_for_label_no_replacement","","",null,null],[5,"encoding_for_name","","",null,null],[5,"encoding_name","","Writes the name of the given `Encoding` to a caller-supplied buffer as ASCII\nand returns the number of bytes / ASCII characters written.",null,null],[5,"encoding_can_encode_everything","","",null,null],[5,"encoding_output_encoding","","",null,null],[5,"encoding_new_decoder","","Allocates a new `Decoder` for the given `Encoding` on the heap with BOM\nsniffing enabled and returns a pointer to the newly-allocated `Decoder`.",null,null],[5,"encoding_new_decoder_with_bom_removal","","Allocates a new `Decoder` for the given `Encoding` on the heap with BOM\nremoval and returns a pointer to the newly-allocated `Decoder`.",null,null],[5,"encoding_new_decoder_without_bom_handling","","Allocates a new `Decoder` for the given `Encoding` on the heap with BOM\nhandling disabled and returns a pointer to the newly-allocated `Decoder`.",null,null],[5,"encoding_new_decoder_into","","Allocates a new `Decoder` for the given `Encoding` into memory provided by\nthe caller with BOM sniffing enabled. (In practice, the target should\nlikely be a pointer previously returned by `encoding_new_decoder()`.)",null,null],[5,"encoding_new_decoder_with_bom_removal_into","","Allocates a new `Decoder` for the given `Encoding` into memory provided by\nthe caller with BOM removal.",null,null],[5,"encoding_new_decoder_without_bom_handling_into","","Allocates a new `Decoder` for the given `Encoding` into memory provided by\nthe caller with BOM handling disabled.",null,null],[5,"encoding_new_encoder","","Allocates a new `Encoder` for the given `Encoding` on the heap and returns a\npointer to the newly-allocated `Encoder`. (Exception, if the `Encoding` is\n`replacement`, a new `Decoder` for UTF-8 is instantiated (and that\n`Decoder` reports `UTF_8` as its `Encoding`).",null,null],[5,"encoding_new_encoder_into","","Allocates a new `Encoder` for the given `Encoding` into memory provided by\nthe caller. (In practice, the target should likely be a pointer previously\nreturned by `encoding_new_encoder()`.)",null,null],[5,"decoder_free","","Deallocates a `Decoder` previously allocated by `encoding_new_decoder()`.",null,null],[5,"decoder_encoding","","",null,null],[5,"decoder_max_utf16_buffer_length","","",null,null],[5,"decoder_max_utf8_buffer_length_without_replacement","","",null,null],[5,"decoder_max_utf8_buffer_length","","",null,null],[5,"decoder_decode_to_utf16_without_replacement","","",null,null],[5,"decoder_decode_to_utf8_without_replacement","","",null,null],[5,"decoder_decode_to_utf16","","",null,null],[5,"decoder_decode_to_utf8","","",null,null],[5,"encoder_free","","Deallocates an `Encoder` previously allocated by `encoding_new_encoder()`.",null,null],[5,"encoder_encoding","","",null,null],[5,"encoder_max_buffer_length_from_utf16_without_replacement","","",null,null],[5,"encoder_max_buffer_length_from_utf8_without_replacement","","",null,null],[5,"encoder_max_buffer_length_from_utf16_if_no_unmappables","","",null,null],[5,"encoder_max_buffer_length_from_utf8_if_no_unmappables","","",null,null],[5,"encoder_encode_from_utf16_without_replacement","","",null,null],[5,"encoder_encode_from_utf8_without_replacement","","",null,null],[5,"encoder_encode_from_utf16","","",null,null],[5,"encoder_encode_from_utf8","","",null,null],[7,"BIG5_ENCODING","","The Big5 encoding.",null,null],[7,"EUC_JP_ENCODING","","The EUC-JP encoding.",null,null],[7,"EUC_KR_ENCODING","","The EUC-KR encoding.",null,null],[7,"GBK_ENCODING","","The GBK encoding.",null,null],[7,"IBM866_ENCODING","","The IBM866 encoding.",null,null],[7,"ISO_2022_JP_ENCODING","","The ISO-2022-JP encoding.",null,null],[7,"ISO_8859_10_ENCODING","","The ISO-8859-10 encoding.",null,null],[7,"ISO_8859_13_ENCODING","","The ISO-8859-13 encoding.",null,null],[7,"ISO_8859_14_ENCODING","","The ISO-8859-14 encoding.",null,null],[7,"ISO_8859_15_ENCODING","","The ISO-8859-15 encoding.",null,null],[7,"ISO_8859_16_ENCODING","","The ISO-8859-16 encoding.",null,null],[7,"ISO_8859_2_ENCODING","","The ISO-8859-2 encoding.",null,null],[7,"ISO_8859_3_ENCODING","","The ISO-8859-3 encoding.",null,null],[7,"ISO_8859_4_ENCODING","","The ISO-8859-4 encoding.",null,null],[7,"ISO_8859_5_ENCODING","","The ISO-8859-5 encoding.",null,null],[7,"ISO_8859_6_ENCODING","","The ISO-8859-6 encoding.",null,null],[7,"ISO_8859_7_ENCODING","","The ISO-8859-7 encoding.",null,null],[7,"ISO_8859_8_ENCODING","","The ISO-8859-8 encoding.",null,null],[7,"ISO_8859_8_I_ENCODING","","The ISO-8859-8-I encoding.",null,null],[7,"KOI8_R_ENCODING","","The KOI8-R encoding.",null,null],[7,"KOI8_U_ENCODING","","The KOI8-U encoding.",null,null],[7,"SHIFT_JIS_ENCODING","","The Shift_JIS encoding.",null,null],[7,"UTF_16BE_ENCODING","","The UTF-16BE encoding.",null,null],[7,"UTF_16LE_ENCODING","","The UTF-16LE encoding.",null,null],[7,"UTF_8_ENCODING","","The UTF-8 encoding.",null,null],[7,"GB18030_ENCODING","","The gb18030 encoding.",null,null],[7,"MACINTOSH_ENCODING","","The macintosh encoding.",null,null],[7,"REPLACEMENT_ENCODING","","The replacement encoding.",null,null],[7,"WINDOWS_1250_ENCODING","","The windows-1250 encoding.",null,null],[7,"WINDOWS_1251_ENCODING","","The windows-1251 encoding.",null,null],[7,"WINDOWS_1252_ENCODING","","The windows-1252 encoding.",null,null],[7,"WINDOWS_1253_ENCODING","","The windows-1253 encoding.",null,null],[7,"WINDOWS_1254_ENCODING","","The windows-1254 encoding.",null,null],[7,"WINDOWS_1255_ENCODING","","The windows-1255 encoding.",null,null],[7,"WINDOWS_1256_ENCODING","","The windows-1256 encoding.",null,null],[7,"WINDOWS_1257_ENCODING","","The windows-1257 encoding.",null,null],[7,"WINDOWS_1258_ENCODING","","The windows-1258 encoding.",null,null],[7,"WINDOWS_874_ENCODING","","The windows-874 encoding.",null,null],[7,"X_MAC_CYRILLIC_ENCODING","","The x-mac-cyrillic encoding.",null,null],[7,"X_USER_DEFINED_ENCODING","","The x-user-defined encoding.",null,null],[17,"INPUT_EMPTY","","Return value for `*_decode_*` and `*_encode_*` methods that indicates that\nthe input has been exhausted.",null,null],[17,"OUTPUT_FULL","","Return value for `*_decode_*` and `*_encode_*` methods that indicates that\nthe output space has been exhausted.",null,null],[17,"ENCODING_NAME_MAX_LENGTH","","The minimum length of buffers that may be passed to `encoding_name()`.",null,null],[17,"BIG5","encoding_rs","The Big5 encoding.",null,null],[17,"EUC_JP","","The EUC-JP encoding.",null,null],[17,"EUC_KR","","The EUC-KR encoding.",null,null],[17,"GBK","","The GBK encoding.",null,null],[17,"IBM866","","The IBM866 encoding.",null,null],[17,"ISO_2022_JP","","The ISO-2022-JP encoding.",null,null],[17,"ISO_8859_10","","The ISO-8859-10 encoding.",null,null],[17,"ISO_8859_13","","The ISO-8859-13 encoding.",null,null],[17,"ISO_8859_14","","The ISO-8859-14 encoding.",null,null],[17,"ISO_8859_15","","The ISO-8859-15 encoding.",null,null],[17,"ISO_8859_16","","The ISO-8859-16 encoding.",null,null],[17,"ISO_8859_2","","The ISO-8859-2 encoding.",null,null],[17,"ISO_8859_3","","The ISO-8859-3 encoding.",null,null],[17,"ISO_8859_4","","The ISO-8859-4 encoding.",null,null],[17,"ISO_8859_5","","The ISO-8859-5 encoding.",null,null],[17,"ISO_8859_6","","The ISO-8859-6 encoding.",null,null],[17,"ISO_8859_7","","The ISO-8859-7 encoding.",null,null],[17,"ISO_8859_8","","The ISO-8859-8 encoding.",null,null],[17,"ISO_8859_8_I","","The ISO-8859-8-I encoding.",null,null],[17,"KOI8_R","","The KOI8-R encoding.",null,null],[17,"KOI8_U","","The KOI8-U encoding.",null,null],[17,"SHIFT_JIS","","The Shift_JIS encoding.",null,null],[17,"UTF_16BE","","The UTF-16BE encoding.",null,null],[17,"UTF_16LE","","The UTF-16LE encoding.",null,null],[17,"UTF_8","","The UTF-8 encoding.",null,null],[17,"GB18030","","The gb18030 encoding.",null,null],[17,"MACINTOSH","","The macintosh encoding.",null,null],[17,"REPLACEMENT","","The replacement encoding.",null,null],[17,"WINDOWS_1250","","The windows-1250 encoding.",null,null],[17,"WINDOWS_1251","","The windows-1251 encoding.",null,null],[17,"WINDOWS_1252","","The windows-1252 encoding.",null,null],[17,"WINDOWS_1253","","The windows-1253 encoding.",null,null],[17,"WINDOWS_1254","","The windows-1254 encoding.",null,null],[17,"WINDOWS_1255","","The windows-1255 encoding.",null,null],[17,"WINDOWS_1256","","The windows-1256 encoding.",null,null],[17,"WINDOWS_1257","","The windows-1257 encoding.",null,null],[17,"WINDOWS_1258","","The windows-1258 encoding.",null,null],[17,"WINDOWS_874","","The windows-874 encoding.",null,null],[17,"X_MAC_CYRILLIC","","The x-mac-cyrillic encoding.",null,null],[17,"X_USER_DEFINED","","The x-user-defined encoding.",null,null],[11,"for_label","","Implements the\n[_get an encoding_](https://encoding.spec.whatwg.org/#concept-encoding-get)\nalgorithm.",3,null],[11,"for_label_no_replacement","","This method behaves the same as `for_label()`, except when `for_label()`\nwould return `Some(REPLACEMENT)`, this method returns `None` instead.",3,null],[11,"for_name","","If the argument matches exactly (case-sensitively; no whitespace\nremoval performed) the name of an encoding, returns\n`Some(&'static Encoding)` representing that encoding. Otherwise,\nreturn `None`.",3,null],[11,"name","","Returns the name of this encoding.",3,null],[11,"can_encode_everything","","Checks whether the _output encoding_ of this encoding can encode every\n`char`. (Only true if the output encoding is UTF-8.)",3,null],[11,"output_encoding","","Returns the _output encoding_ of this encoding. This is UTF-8 for\nUTF-16BE, UTF-16LE and replacement and the encoding itself otherwise.",3,null],[11,"new_decoder","","Instantiates a new decoder for this encoding with BOM sniffing enabled.",3,null],[11,"new_decoder_with_bom_removal","","Instantiates a new decoder for this encoding with BOM removal.",3,null],[11,"new_decoder_without_bom_handling","","Instantiates a new decoder for this encoding with BOM handling disabled.",3,null],[11,"new_encoder","","Instantiates a new encoder for the output encoding of this encoding.",3,null],[11,"decode","","Convenience method for decoding to `String` _with BOM sniffing_ and with\nmalformed sequences replaced with the REPLACEMENT CHARACTER when the\nentire input is available as a single buffer (i.e. the end of the\nbuffer marks the end of the stream).",3,null],[11,"decode_with_bom_removal","","Convenience method for decoding to `String` _with BOM removal_ and with\nmalformed sequences replaced with the REPLACEMENT CHARACTER when the\nentire input is available as a single buffer (i.e. the end of the\nbuffer marks the end of the stream).",3,null],[11,"decode_without_bom_handling","","Convenience method for decoding to `String` _without BOM handling_ and\nwith malformed sequences replaced with the REPLACEMENT CHARACTER when\nthe entire input is available as a single buffer (i.e. the end of the\nbuffer marks the end of the stream).",3,null],[11,"decode_without_bom_handling_and_without_replacement","","Convenience method for decoding to `String` _without BOM handling_ and\n_with malformed sequences treated as fatal_ when the entire input is\navailable as a single buffer (i.e. the end of the buffer marks the end\nof the stream).",3,null],[11,"encode","","Convenience method for encoding to `Vec<u8>` with unmappable characters\nreplaced with decimal numeric character references when the entire input\nis available as a single buffer (i.e. the end of the buffer marks the\nend of the stream).",3,null],[11,"eq","","",3,null],[11,"fmt","","",3,null],[11,"fmt","","",0,null],[11,"fmt","","",1,null],[11,"encoding","","The `Encoding` this `Decoder` is for.",4,null],[11,"max_utf16_buffer_length","","Query the worst-case UTF-16 output size (with or without replacement).",4,null],[11,"max_utf8_buffer_length_without_replacement","","Query the worst-case UTF-8 output size _without replacement_.",4,null],[11,"max_utf8_buffer_length","","Query the worst-case UTF-8 output size _with replacement_.",4,null],[11,"decode_to_utf16_without_replacement","","",4,null],[11,"decode_to_utf8_without_replacement","","",4,null],[11,"decode_to_str_without_replacement","","Incrementally decode a byte stream into UTF-8 with type system signaling\nof UTF-8 validity.",4,null],[11,"decode_to_string_without_replacement","","Incrementally decode a byte stream into UTF-8 using a `String` receiver.",4,null],[11,"decode_to_utf16","","Incrementally decode a byte stream into UTF-16 with malformed sequences\nreplaced with the REPLACEMENT CHARACTER.",4,null],[11,"decode_to_utf8","","Incrementally decode a byte stream into UTF-8 with malformed sequences\nreplaced with the REPLACEMENT CHARACTER.",4,null],[11,"decode_to_str","","Incrementally decode a byte stream into UTF-8 with malformed sequences\nreplaced with the REPLACEMENT CHARACTER with type system signaling\nof UTF-8 validity.",4,null],[11,"decode_to_string","","Incrementally decode a byte stream into UTF-8 with malformed sequences\nreplaced with the REPLACEMENT CHARACTER using a `String` receiver.",4,null],[11,"fmt","","",2,null],[11,"encoding","","The `Encoding` this `Encoder` is for.",5,null],[11,"max_buffer_length_from_utf16_without_replacement","","Query the worst-case output size when encoding from UTF-16 without\nreplacement.",5,null],[11,"max_buffer_length_from_utf8_without_replacement","","Query the worst-case output size when encoding from UTF-8 without\nreplacement.",5,null],[11,"max_buffer_length_from_utf16_if_no_unmappables","","Query the worst-case output size when encoding from UTF-16 with\nreplacement.",5,null],[11,"max_buffer_length_from_utf8_if_no_unmappables","","Query the worst-case output size when encoding from UTF-8 with\nreplacement.",5,null],[11,"encode_from_utf16_without_replacement","","Incrementally encode into byte stream from UTF-16.",5,null],[11,"encode_from_utf8_without_replacement","","Incrementally encode into byte stream from UTF-8.",5,null],[11,"encode_from_utf16","","Incrementally encode into byte stream from UTF-16 with replacement.",5,null],[11,"encode_from_utf8","","Incrementally encode into byte stream from UTF-8 with replacement.",5,null],[11,"encode_from_utf8_to_vec","","Incrementally encode into byte stream from UTF-8 with replacement.",5,null]],"paths":[[4,"CoderResult"],[4,"DecoderResult"],[4,"EncoderResult"],[3,"Encoding"],[3,"Decoder"],[3,"Encoder"]]};
initSearch(searchIndex);