2024-05-07 06:31:16 +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 = "Used by `Parser::context` to add custom data to error while backtracking" > < title > AddContext in winnow::error - 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 = "winnow" 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 > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < h2 > < a href = "../../winnow/index.html" > winnow< / a > < span class = "version" > 0.6.8< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > AddContext< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#provided-methods" > Provided Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#method.add_context" > add_context< / a > < / li > < / ul > < h3 > < a href = "#foreign-impls" > Implementations on Foreign Types< / a > < / h3 > < ul class = "block" > < li > < a href = "#impl-AddContext%3CI,+C%3E-for-()" > ()< / 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 winnow::error< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div >
2024-05-05 09:43:20 +00:00
< main > < div class = "width-limiter" > < nav class = "sub" > < form class = "search-form" > < span > < / span > < div id = "sidebar-button" tabindex = "-1" > < a href = "../../winnow/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" > winnow< / a > ::< wbr > < a href = "index.html" > error< / a > ::< wbr > < a class = "trait" href = "#" > AddContext< / 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/winnow/error.rs.html#305-319" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait AddContext< I: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > , C = & 'static < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.str.html" > str< / a > > : < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > {
2024-03-11 08:39:13 +00:00
// Provided method
fn < a href = "#method.add_context" class = "fn" > add_context< / a > (
self,
2024-05-05 09:43:20 +00:00
_input: < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.reference.html" > & I< / a > ,
2024-03-11 08:39:13 +00:00
_token_start: & < I as < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > > ::< a class = "associatedtype" href = "../stream/trait.Stream.html#associatedtype.Checkpoint" title = "type winnow::stream::Stream::Checkpoint" > Checkpoint< / a > ,
_context: C
) -> Self { ... }
}< / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Used by < a href = "../trait.Parser.html#method.context" title = "method winnow::Parser::context" > < code > Parser::context< / code > < / a > to add custom data to error while backtracking< / p >
< p > May be implemented multiple times for different kinds of context.< / p >
< / div > < / details > < h2 id = "provided-methods" class = "section-header" > Provided Methods< a href = "#provided-methods" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle method-toggle" open > < summary > < section id = "method.add_context" class = "method" > < a class = "src rightside" href = "../../src/winnow/error.rs.html#311-318" > source< / a > < h4 class = "code-header" > fn < a href = "#method.add_context" class = "fn" > add_context< / a > (
self,
2024-05-05 09:43:20 +00:00
_input: < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.reference.html" > & I< / a > ,
2024-03-11 08:39:13 +00:00
_token_start: & < I as < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > > ::< a class = "associatedtype" href = "../stream/trait.Stream.html#associatedtype.Checkpoint" title = "type winnow::stream::Stream::Checkpoint" > Checkpoint< / a > ,
_context: C
) -> Self< / h4 > < / section > < / summary > < div class = "docblock" > < p > Append to an existing error custom data< / p >
< p > This is used mainly by < a href = "../trait.Parser.html#method.context" title = "method winnow::Parser::context" > < code > Parser::context< / code > < / a > , to add user friendly information
to errors when backtracking through a parse tree< / p >
2024-05-07 06:31:16 +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 > < section id = "impl-AddContext%3CI,+C%3E-for-()" class = "impl" > < a class = "src rightside" href = "../../src/winnow/error.rs.html#490" > source< / a > < a href = "#impl-AddContext%3CI,+C%3E-for-()" class = "anchor" > §< / a > < h3 class = "code-header" > impl< I: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > , C> < a class = "trait" href = "trait.AddContext.html" title = "trait winnow::error::AddContext" > AddContext< / a > < I, C> for < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.unit.html" > ()< / a > < / h3 > < / section > < h2 id = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < section id = "impl-AddContext%3CI,+C%3E-for-ContextError%3CC%3E" class = "impl" > < a class = "src rightside" href = "../../src/winnow/error.rs.html#591-603" > source< / a > < a href = "#impl-AddContext%3CI,+C%3E-for-ContextError%3CC%3E" class = "anchor" > §< / a > < h3 class = "code-header" > impl< C, I: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > > < a class = "trait" href = "trait.AddContext.html" title = "trait winnow::error::AddContext" > AddContext< / a > < I, C> for < a class = "struct" href = "struct.ContextError.html" title = "struct winnow::error::ContextError" > ContextError< / a > < C> < / h3 > < / section > < section id = "impl-AddContext%3CI,+C%3E-for-TreeError%3CI,+C%3E" class = "impl" > < a class = "src rightside" href = "../../src/winnow/error.rs.html#943-953" > source< / a > < a href = "#impl-AddContext%3CI,+C%3E-for-TreeError%3CI,+C%3E" class = "anchor" > §< / a > < h3 class = "code-header" > impl< I, C> < a class = "trait" href = "trait.AddContext.html" title = "trait winnow::error::AddContext" > AddContext< / a > < I, C> for < a class = "enum" href = "enum.TreeError.html" title = "enum winnow::error::TreeError" > TreeError< / a > < I, C> < div class = "where" > where
I: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > + < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html" title = "trait core::clone::Clone" > Clone< / a > ,< / div > < / h3 > < / section > < section id = "impl-AddContext%3CI,+C%3E-for-InputError%3CI%3E" class = "impl" > < a class = "src rightside" href = "../../src/winnow/error.rs.html#411" > source< / a > < a href = "#impl-AddContext%3CI,+C%3E-for-InputError%3CI%3E" class = "anchor" > §< / a > < h3 class = "code-header" > impl< I: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > + < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/clone/trait.Clone.html" title = "trait core::clone::Clone" > Clone< / a > , C> < a class = "trait" href = "trait.AddContext.html" title = "trait winnow::error::AddContext" > AddContext< / a > < I, C> for < a class = "struct" href = "struct.InputError.html" title = "struct winnow::error::InputError" > InputError< / a > < I> < / h3 > < / section > < section id = "impl-AddContext%3CI,+C%3E-for-ErrorKind" class = "impl" > < a class = "src rightside" href = "../../src/winnow/error.rs.html#1138" > source< / a > < a href = "#impl-AddContext%3CI,+C%3E-for-ErrorKind" class = "anchor" > §< / a > < h3 class = "code-header" > impl< I: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > , C> < a class = "trait" href = "trait.AddContext.html" title = "trait winnow::error::AddContext" > AddContext< / a > < I, C> for < a class = "enum" href = "enum.ErrorKind.html" title = "enum winnow::error::ErrorKind" > ErrorKind< / a > < / h3 > < / section > < section id = "impl-AddContext%3CI,+C%3E-for-ErrMode%3CE%3E" class = "impl" > < a class = "src rightside" href = "../../src/winnow/error.rs.html#223-228" > source< / a > < a href = "#impl-AddContext%3CI,+C%3E-for-ErrMode%3CE%3E" class = "anchor" > §< / a > < h3 class = "code-header" > impl< I: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > , C, E: < a class = "trait" href = "trait.AddContext.html" title = "trait winnow::error::AddContext" > AddContext< / a > < I, C> > < a class = "trait" href = "trait.AddContext.html" title = "trait winnow::error::AddContext" > AddContext< / a > < I, C> for < a class = "enum" href = "enum.ErrMode.html" title = "enum winnow::error::ErrMode" > ErrMode< / a > < E> < / h3 > < / section > < / div > < script src = "../../trait.impl/winnow/error/trait.AddContext.js" data-ignore-extern-crates = "std" async > < / script > < / section > < / div > < / main > < / body > < / html >
