-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathindex.html
39 lines (39 loc) · 15.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="FFI bindings for `encoding_rs::mem`."><title>encoding_c_mem - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="encoding_c_mem" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../encoding_c_mem/index.html">encoding_<wbr>c_<wbr>mem</a><span class="version">0.2.6</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#functions">Crate Items</a></h3><ul class="block"><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>encoding_c_mem</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/encoding_c_mem/lib.rs.html#10-825">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>FFI bindings for <code>encoding_rs::mem</code>.</p>
<p><em>Note:</em> “Latin1” in this module refers to the Unicode range from U+0000 to
U+00FF, inclusive, and does not refer to the windows-1252 range. This
in-memory encoding is sometimes used as a storage optimization of text
when UTF-16 indexing and length semantics are exposed.</p>
</div></details><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.encoding_mem_check_str_for_latin1_and_bidi.html" title="fn encoding_c_mem::encoding_mem_check_str_for_latin1_and_bidi">encoding_<wbr>mem_<wbr>check_<wbr>str_<wbr>for_<wbr>latin1_<wbr>and_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a valid UTF-8 buffer contains code points
that trigger right-to-left processing or is all-Latin1.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_check_utf8_for_latin1_and_bidi.html" title="fn encoding_c_mem::encoding_mem_check_utf8_for_latin1_and_bidi">encoding_<wbr>mem_<wbr>check_<wbr>utf8_<wbr>for_<wbr>latin1_<wbr>and_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a potentially invalid UTF-8 buffer contains code points
that trigger right-to-left processing or is all-Latin1.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_check_utf16_for_latin1_and_bidi.html" title="fn encoding_c_mem::encoding_mem_check_utf16_for_latin1_and_bidi">encoding_<wbr>mem_<wbr>check_<wbr>utf16_<wbr>for_<wbr>latin1_<wbr>and_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a potentially invalid UTF-16 buffer contains code points
that trigger right-to-left processing or is all-Latin1.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_latin1_to_utf8.html" title="fn encoding_c_mem::encoding_mem_convert_latin1_to_utf8">encoding_<wbr>mem_<wbr>convert_<wbr>latin1_<wbr>to_<wbr>utf8</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts bytes whose unsigned value is interpreted as Unicode code point
(i.e. U+0000 to U+00FF, inclusive) to UTF-8.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_latin1_to_utf8_partial.html" title="fn encoding_c_mem::encoding_mem_convert_latin1_to_utf8_partial">encoding_<wbr>mem_<wbr>convert_<wbr>latin1_<wbr>to_<wbr>utf8_<wbr>partial</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts bytes whose unsigned value is interpreted as Unicode code point
(i.e. U+0000 to U+00FF, inclusive) to UTF-8 with potentially insufficient
output space.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_latin1_to_utf16.html" title="fn encoding_c_mem::encoding_mem_convert_latin1_to_utf16">encoding_<wbr>mem_<wbr>convert_<wbr>latin1_<wbr>to_<wbr>utf16</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts bytes whose unsigned value is interpreted as Unicode code point
(i.e. U+0000 to U+00FF, inclusive) to UTF-16.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_str_to_utf16.html" title="fn encoding_c_mem::encoding_mem_convert_str_to_utf16">encoding_<wbr>mem_<wbr>convert_<wbr>str_<wbr>to_<wbr>utf16</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts valid UTF-8 to valid UTF-16.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_utf8_to_latin1_lossy.html" title="fn encoding_c_mem::encoding_mem_convert_utf8_to_latin1_lossy">encoding_<wbr>mem_<wbr>convert_<wbr>utf8_<wbr>to_<wbr>latin1_<wbr>lossy</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">If the input is valid UTF-8 representing only Unicode code points from
U+0000 to U+00FF, inclusive, converts the input into output that
represents the value of each code point as the unsigned byte value of
each output byte.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_utf8_to_utf16.html" title="fn encoding_c_mem::encoding_mem_convert_utf8_to_utf16">encoding_<wbr>mem_<wbr>convert_<wbr>utf8_<wbr>to_<wbr>utf16</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts potentially-invalid UTF-8 to valid UTF-16 with errors replaced
with the REPLACEMENT CHARACTER.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_utf8_to_utf16_without_replacement.html" title="fn encoding_c_mem::encoding_mem_convert_utf8_to_utf16_without_replacement">encoding_<wbr>mem_<wbr>convert_<wbr>utf8_<wbr>to_<wbr>utf16_<wbr>without_<wbr>replacement</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts potentially-invalid UTF-8 to valid UTF-16 signaling on error.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_utf16_to_latin1_lossy.html" title="fn encoding_c_mem::encoding_mem_convert_utf16_to_latin1_lossy">encoding_<wbr>mem_<wbr>convert_<wbr>utf16_<wbr>to_<wbr>latin1_<wbr>lossy</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">If the input is valid UTF-16 representing only Unicode code points from
U+0000 to U+00FF, inclusive, converts the input into output that
represents the value of each code point as the unsigned byte value of
each output byte.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_utf16_to_utf8.html" title="fn encoding_c_mem::encoding_mem_convert_utf16_to_utf8">encoding_<wbr>mem_<wbr>convert_<wbr>utf16_<wbr>to_<wbr>utf8</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts potentially-invalid UTF-16 to valid UTF-8 with errors replaced
with the REPLACEMENT CHARACTER.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_convert_utf16_to_utf8_partial.html" title="fn encoding_c_mem::encoding_mem_convert_utf16_to_utf8_partial">encoding_<wbr>mem_<wbr>convert_<wbr>utf16_<wbr>to_<wbr>utf8_<wbr>partial</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Converts potentially-invalid UTF-16 to valid UTF-8 with errors replaced
with the REPLACEMENT CHARACTER with potentially insufficient output
space.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_copy_ascii_to_ascii.html" title="fn encoding_c_mem::encoding_mem_copy_ascii_to_ascii">encoding_<wbr>mem_<wbr>copy_<wbr>ascii_<wbr>to_<wbr>ascii</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Copies ASCII from source to destination up to the first non-ASCII byte
(or the end of the input if it is ASCII in its entirety).</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_copy_ascii_to_basic_latin.html" title="fn encoding_c_mem::encoding_mem_copy_ascii_to_basic_latin">encoding_<wbr>mem_<wbr>copy_<wbr>ascii_<wbr>to_<wbr>basic_<wbr>latin</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Copies ASCII from source to destination zero-extending it to UTF-16 up to
the first non-ASCII byte (or the end of the input if it is ASCII in its
entirety).</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_copy_basic_latin_to_ascii.html" title="fn encoding_c_mem::encoding_mem_copy_basic_latin_to_ascii">encoding_<wbr>mem_<wbr>copy_<wbr>basic_<wbr>latin_<wbr>to_<wbr>ascii</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Copies Basic Latin from source to destination narrowing it to ASCII up to
the first non-Basic Latin code unit (or the end of the input if it is
Basic Latin in its entirety).</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_ensure_utf16_validity.html" title="fn encoding_c_mem::encoding_mem_ensure_utf16_validity">encoding_<wbr>mem_<wbr>ensure_<wbr>utf16_<wbr>validity</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Replaces unpaired surrogates in the input with the REPLACEMENT CHARACTER.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_ascii.html" title="fn encoding_c_mem::encoding_mem_is_ascii">encoding_<wbr>mem_<wbr>is_<wbr>ascii</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether the buffer is all-ASCII.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_basic_latin.html" title="fn encoding_c_mem::encoding_mem_is_basic_latin">encoding_<wbr>mem_<wbr>is_<wbr>basic_<wbr>latin</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether the buffer is all-Basic Latin (i.e. UTF-16 representing
only ASCII characters).</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_char_bidi.html" title="fn encoding_c_mem::encoding_mem_is_char_bidi">encoding_<wbr>mem_<wbr>is_<wbr>char_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a scalar value triggers right-to-left processing.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_str_bidi.html" title="fn encoding_c_mem::encoding_mem_is_str_bidi">encoding_<wbr>mem_<wbr>is_<wbr>str_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a valid UTF-8 buffer contains code points that trigger
right-to-left processing.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_str_latin1.html" title="fn encoding_c_mem::encoding_mem_is_str_latin1">encoding_<wbr>mem_<wbr>is_<wbr>str_<wbr>latin1</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether the buffer represents only code points less than or equal
to U+00FF.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_utf8_bidi.html" title="fn encoding_c_mem::encoding_mem_is_utf8_bidi">encoding_<wbr>mem_<wbr>is_<wbr>utf8_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a potentially-invalid UTF-8 buffer contains code points
that trigger right-to-left processing.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_utf8_latin1.html" title="fn encoding_c_mem::encoding_mem_is_utf8_latin1">encoding_<wbr>mem_<wbr>is_<wbr>utf8_<wbr>latin1</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether the buffer is valid UTF-8 representing only code points
less than or equal to U+00FF.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_utf16_bidi.html" title="fn encoding_c_mem::encoding_mem_is_utf16_bidi">encoding_<wbr>mem_<wbr>is_<wbr>utf16_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a UTF-16 buffer contains code points that trigger
right-to-left processing.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_utf16_code_unit_bidi.html" title="fn encoding_c_mem::encoding_mem_is_utf16_code_unit_bidi">encoding_<wbr>mem_<wbr>is_<wbr>utf16_<wbr>code_<wbr>unit_<wbr>bidi</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether a UTF-16 code unit triggers right-to-left processing.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_is_utf16_latin1.html" title="fn encoding_c_mem::encoding_mem_is_utf16_latin1">encoding_<wbr>mem_<wbr>is_<wbr>utf16_<wbr>latin1</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Checks whether the buffer represents only code point less than or equal
to U+00FF.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_str_latin1_up_to.html" title="fn encoding_c_mem::encoding_mem_str_latin1_up_to">encoding_<wbr>mem_<wbr>str_<wbr>latin1_<wbr>up_<wbr>to</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the index of first byte that starts a non-Latin1 byte
sequence, or the length of the string if there are none.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_utf8_latin1_up_to.html" title="fn encoding_c_mem::encoding_mem_utf8_latin1_up_to">encoding_<wbr>mem_<wbr>utf8_<wbr>latin1_<wbr>up_<wbr>to</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the index of first byte that starts an invalid byte
sequence or a non-Latin1 byte sequence, or the length of the
string if there are neither.</div></li><li><div class="item-name"><a class="fn" href="fn.encoding_mem_utf16_valid_up_to.html" title="fn encoding_c_mem::encoding_mem_utf16_valid_up_to">encoding_<wbr>mem_<wbr>utf16_<wbr>valid_<wbr>up_<wbr>to</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the index of the first unpaired surrogate or, if the input is
valid UTF-16 in its entirety, the length of the input.</div></li></ul></section></div></main></body></html>