2024-05-05 09:43:20 +00:00
<!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 = "A fixed, statically sized chunk of data that can be read from the `Source`." > < title > Chunk in logos::source - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . write ( ` <link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"> ` ) < / script > < link rel = "stylesheet" href = "../../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../../static.files/rustdoc-e935ef01ae1c1829.css" > < meta name = "rustdoc-vars" data-root-path = "../../" data-static-root-path = "../../static.files/" data-current-crate = "logos" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.78.0 (9b00956e5 2024-04-29)" data-channel = "1.78.0" data-search-js = "search-42d8da7a6b9792c2.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../../static.files/storage-4c98445ec4002617.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../../static.files/main-12cf3b4f4f9dc36d.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../static.files/noscript-04d5337699b92874.css" > < / noscript > < link rel = "alternate icon" type = "image/png" href = "../../static.files/favicon-16x16-8b506e7a72182f1c.png" > < link rel = "alternate icon" type = "image/png" href = "../../static.files/favicon-32x32-422f7d1d52889060.png" > < link rel = "icon" type = "image/svg+xml" href = "../../static.files/favicon-2c020d218678b618.svg" > < / head > < body class = "rustdoc trait" > <!-- [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 > < a class = "logo-container" href = "../../logos/index.html" > < img src = "https://maciej.codes/kosz/logos.png" alt = "" > < / a > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < a class = "logo-container" href = "../../logos/index.html" > < img src = "https://maciej.codes/kosz/logos.png" alt = "logo" > < / a > < h2 > < a href = "../../logos/index.html" > logos< / a > < span class = "version" > 0.14.0< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > Chunk< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#required-associated-consts" > Required Associated Constants< / a > < / h3 > < ul class = "block" > < li > < a href = "#associatedconstant.SIZE" > SIZE< / a > < / li > < / ul > < h3 > < a href = "#required-methods" > Required Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#tymethod.from_ptr" > from_ptr< / a > < / li > < / ul > < h3 > < a href = "#foreign-impls" > Implementations on Foreign Types< / a > < / h3 > < ul class = "block" > < li > < a href = "#impl-Chunk%3C'source%3E-for-%26%5Bu8;+N%5D" > & ' source [u8; N]< / a > < / li > < li > < a href = "#impl-Chunk%3C'source%3E-for-u8" > u8< / a > < / li > < / ul > < h3 > < a href = "#object-safety" > Object Safety< / a > < / h3 > < h3 > < a href = "#implementors" > Implementors< / a > < / h3 > < / section > < h2 > < a href = "index.html" > In logos::source< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div >
< main > < div class = "width-limiter" > < nav class = "sub" > < form class = "search-form" > < span > < / span > < div id = "sidebar-button" tabindex = "-1" > < a href = "../../logos/all.html" title = "show sidebar" > < / a > < / div > < input class = "search-input" name = "search" aria-label = "Run search in the documentation" autocomplete = "off" spellcheck = "false" placeholder = "Click or press ‘ ’ ‘ ’ type = "search" > < div id = "help-button" tabindex = "-1" > < a href = "../../help.html" title = "help" > ?< / a > < / div > < div id = "settings-menu" tabindex = "-1" > < a href = "../../settings.html" title = "settings" > < img width = "22" height = "22" alt = "Change settings" src = "../../static.files/wheel-7b819b6101059cd0.svg" > < / a > < / div > < / form > < / nav > < section id = "main-content" class = "content" > < div class = "main-heading" > < h1 > Trait < a href = "../index.html" > logos< / a > ::< wbr > < a href = "index.html" > source< / a > ::< wbr > < a class = "trait" href = "#" > Chunk< / a > < button id = "copy-path" title = "Copy item path to clipboard" > < img src = "../../static.files/clipboard-7571035ce49a181d.svg" width = "19" height = "18" alt = "Copy item path" > < / button > < / h1 > < span class = "out-of-band" > < a class = "src" href = "../../src/logos/source.rs.html#215-225" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait Chunk< 'source> : < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > + < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/marker/trait.Copy.html" title = "trait core::marker::Copy" > Copy< / a > + < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/cmp/trait.PartialEq.html" title = "trait core::cmp::PartialEq" > PartialEq< / a > + < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/cmp/trait.Eq.html" title = "trait core::cmp::Eq" > Eq< / a > {
const < a href = "#associatedconstant.SIZE" class = "constant" > SIZE< / a > : < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > ;
2024-02-13 06:38:44 +00:00
// Required method
2024-05-05 09:43:20 +00:00
unsafe fn < a href = "#tymethod.from_ptr" class = "fn" > from_ptr< / a > (ptr: < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html" > *const < / a > < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.u8.html" > u8< / a > ) -> Self;
2024-02-13 06:38:44 +00:00
}< / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > A fixed, statically sized chunk of data that can be read from the < code > Source< / code > .< / p >
< p > This is implemented for < code > u8< / code > , as well as byte arrays < code > & [u8; 1]< / code > to < code > & [u8; 32]< / code > .< / p >
2024-05-05 09:43:20 +00:00
< / div > < / details > < h2 id = "required-associated-consts" class = "section-header" > Required Associated Constants< a href = "#required-associated-consts" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle" open > < summary > < section id = "associatedconstant.SIZE" class = "method" > < a class = "src rightside" href = "../../src/logos/source.rs.html#217" > source< / a > < h4 class = "code-header" > const < a href = "#associatedconstant.SIZE" class = "constant" > SIZE< / a > : < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Size of the chunk being accessed in bytes.< / p >
< / div > < / details > < / div > < h2 id = "required-methods" class = "section-header" > Required Methods< a href = "#required-methods" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle method-toggle" open > < summary > < section id = "tymethod.from_ptr" class = "method" > < a class = "src rightside" href = "../../src/logos/source.rs.html#224" > source< / a > < h4 class = "code-header" > unsafe fn < a href = "#tymethod.from_ptr" class = "fn" > from_ptr< / a > (ptr: < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html" > *const < / a > < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.u8.html" > u8< / a > ) -> Self< / h4 > < / section > < / summary > < div class = "docblock" > < p > Create a chunk from a raw byte pointer.< / p >
2024-03-27 11:12:16 +00:00
< h5 id = "safety" > < a class = "doc-anchor" href = "#safety" > §< / a > Safety< / h5 >
2024-02-13 06:38:44 +00:00
< p > Raw byte pointer should point to a valid location in source.< / p >
2024-05-05 09:43:20 +00:00
< / div > < / details > < / div > < h2 id = "object-safety" class = "section-header" > Object Safety< a href = "#object-safety" class = "anchor" > §< / a > < / h2 > < div class = "object-safety-info" > This trait is < b > not< / b > < a href = "https://doc.rust-lang.org/1.78.0/reference/items/traits.html#object-safety" > object safe< / a > .< / div > < h2 id = "foreign-impls" class = "section-header" > Implementations on Foreign Types< a href = "#foreign-impls" class = "anchor" > §< / a > < / h2 > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-Chunk%3C'source%3E-for-u8" class = "impl" > < a class = "src rightside" href = "../../src/logos/source.rs.html#227-234" > source< / a > < a href = "#impl-Chunk%3C'source%3E-for-u8" class = "anchor" > §< / a > < h3 class = "code-header" > impl< 'source> < a class = "trait" href = "trait.Chunk.html" title = "trait logos::source::Chunk" > Chunk< / a > < 'source> for < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.u8.html" > u8< / a > < / h3 > < / section > < / summary > < div class = "impl-items" > < section id = "associatedconstant.SIZE-1" class = "associatedconstant trait-impl" > < a class = "src rightside" href = "../../src/logos/source.rs.html#228" > source< / a > < a href = "#associatedconstant.SIZE-1" class = "anchor" > §< / a > < h4 class = "code-header" > const < a href = "#associatedconstant.SIZE" class = "constant" > SIZE< / a > : < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > = 1usize< / h4 > < / section > < section id = "method.from_ptr" class = "method trait-impl" > < a class = "src rightside" href = "../../src/logos/source.rs.html#231-233" > source< / a > < a href = "#method.from_ptr" class = "anchor" > §< / a > < h4 class = "code-header" > unsafe fn < a href = "#tymethod.from_ptr" class = "fn" > from_ptr< / a > (ptr: < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html" > *const < / a > < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.u8.html" > u8< / a > ) -> Self< / h4 > < / section > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-Chunk%3C'source%3E-for-%26%5Bu8;+N%5D" class = "impl" > < a class = "src rightside" href = "../../src/logos/source.rs.html#236-243" > source< / a > < a href = "#impl-Chunk%3C'source%3E-for-%26%5Bu8;+N%5D" class = "anchor" > §< / a > < h3 class = "code-header" > impl< 'source, const N: < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > > < a class = "trait" href = "trait.Chunk.html" title = "trait logos::source::Chunk" > Chunk< / a > < 'source> for & 'source [< a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.u8.html" > u8< / a > ; < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.array.html" > N< / a > ]< / h3 > < / section > < / summary > < div class = "impl-items" > < section id = "associatedconstant.SIZE-2" class = "associatedconstant trait-impl" > < a class = "src rightside" href = "../../src/logos/source.rs.html#237" > source< / a > < a href = "#associatedconstant.SIZE-2" class = "anchor" > §< / a > < h4 class = "code-header" > const < a href = "#associatedconstant.SIZE" class = "constant" > SIZE< / a > : < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > = N< / h4 > < / section > < section id = "method.from_ptr-1" class = "method trait-impl" > < a class = "src rightside" href = "../../src/logos/source.rs.html#240-242" > source< / a > < a href = "#method.from_ptr-1" class = "anchor" > §< / a > < h4 class = "code-header" > unsafe fn < a href = "#tymethod.from_ptr" class = "fn" > from_ptr< / a > (ptr: < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.pointer.html" > *const < / a > < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.u8.html" > u8< / a > ) -> Self< / h4 > < / section > < / div > < / details > < h2 id = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < / div > < script src = "../../trait.impl/logos/source/trait.Chunk.js" data-ignore-extern-crates = "std" async > < / script > < / section > < / div > < / main > < / body > < / html >
