2024-04-09 10:18:33 +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 = "Parse escaped characters, unescaping them" > < title > escaped_transform in winnow::ascii - Rust< / title > < 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" > < link rel = "stylesheet" href = "../../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../../static.files/rustdoc-5bc39a1768837dd0.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.77.1 (7cf61ebde 2024-03-27)" data-channel = "1.77.1" data-search-js = "search-dd67cee4cfa65049.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-48f368f3872407c8.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 fn" > <!-- [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.5< / span > < / h2 > < / div > < div class = "sidebar-elems" > < h2 > < a href = "index.html" > In winnow::ascii< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div >
2024-03-11 08:39:13 +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 > Function < a href = "../index.html" > winnow< / a > ::< wbr > < a href = "index.html" > ascii< / a > ::< wbr > < a class = "fn" href = "#" > escaped_transform< / 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/ascii/mod.rs.html#1770-1789" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub fn escaped_transform< Input, Error, Normal, Escape, Output> (
normal: Normal,
2024-04-09 10:18:33 +00:00
control_char: < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.char.html" > char< / a > ,
2024-03-11 08:39:13 +00:00
escape: Escape
) -> impl < a class = "trait" href = "../trait.Parser.html" title = "trait winnow::Parser" > Parser< / a > < Input, Output, Error> < div class = "where" > where
2024-04-09 10:18:33 +00:00
Input: < a class = "trait" href = "../stream/trait.StreamIsPartial.html" title = "trait winnow::stream::StreamIsPartial" > StreamIsPartial< / a > + < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > + < a class = "trait" href = "../stream/trait.Compare.html" title = "trait winnow::stream::Compare" > Compare< / a > < < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.char.html" > char< / a > > ,
2024-03-11 08:39:13 +00:00
Output: < a class = "trait" href = "../stream/trait.Accumulate.html" title = "trait winnow::stream::Accumulate" > Accumulate< / a > < < Input 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.Slice" title = "type winnow::stream::Stream::Slice" > Slice< / a > > ,
Normal: < a class = "trait" href = "../trait.Parser.html" title = "trait winnow::Parser" > Parser< / a > < Input, < Input 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.Slice" title = "type winnow::stream::Stream::Slice" > Slice< / a > , Error> ,
Escape: < a class = "trait" href = "../trait.Parser.html" title = "trait winnow::Parser" > Parser< / a > < Input, < Input 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.Slice" title = "type winnow::stream::Stream::Slice" > Slice< / a > , Error> ,
Error: < a class = "trait" href = "../error/trait.ParserError.html" title = "trait winnow::error::ParserError" > ParserError< / a > < Input> ,< / div > < / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Parse escaped characters, unescaping them< / p >
< p > As an example, the chain < code > abc\tdef< / code > could be < code > abc def< / code > (it also consumes the control character)< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "example" > < a class = "doc-anchor" href = "#example" > §< / a > Example< / h2 >
2024-03-11 08:39:13 +00:00
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > use < / span > winnow::token::literal;
< span class = "kw" > use < / span > winnow::ascii::escaped_transform;
< span class = "kw" > use < / span > winnow::ascii::alpha1;
< span class = "kw" > use < / span > winnow::combinator::alt;
< span class = "kw" > fn < / span > parser< < span class = "lifetime" > 's< / span > > (input: < span class = "kw-2" > & mut & < / span > < span class = "lifetime" > 's < / span > str) -> PResult< String, InputError< < span class = "kw-2" > & < / span > < span class = "lifetime" > 's < / span > str> > {
escaped_transform(
alpha1,
< span class = "string" > '\\'< / span > ,
alt((
< span class = "string" > "\\"< / span > .value(< span class = "string" > "\\"< / span > ),
< span class = "string" > "\""< / span > .value(< span class = "string" > "\""< / span > ),
< span class = "string" > "n"< / span > .value(< span class = "string" > "\n"< / span > ),
))
).parse_next(input)
}
< span class = "macro" > assert_eq!< / span > (parser.parse_peek(< span class = "string" > "ab\\\"cd"< / span > ), < span class = "prelude-val" > Ok< / span > ((< span class = "string" > ""< / span > , String::from(< span class = "string" > "ab\"cd"< / span > ))));
< span class = "macro" > assert_eq!< / span > (parser.parse_peek(< span class = "string" > "ab\\ncd"< / span > ), < span class = "prelude-val" > Ok< / span > ((< span class = "string" > ""< / span > , String::from(< span class = "string" > "ab\ncd"< / span > ))));< / code > < / pre > < / div >
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > use < / span > winnow::token::literal;
< span class = "kw" > use < / span > winnow::ascii::escaped_transform;
< span class = "kw" > use < / span > winnow::ascii::alpha1;
< span class = "kw" > use < / span > winnow::combinator::alt;
< span class = "kw" > fn < / span > parser< < span class = "lifetime" > 's< / span > > (input: < span class = "kw-2" > & mut < / span > Partial< < span class = "kw-2" > & < / span > < span class = "lifetime" > 's < / span > str> ) -> PResult< String, InputError< Partial< < span class = "kw-2" > & < / span > < span class = "lifetime" > 's < / span > str> > > {
escaped_transform(
alpha1,
< span class = "string" > '\\'< / span > ,
alt((
< span class = "string" > "\\"< / span > .value(< span class = "string" > "\\"< / span > ),
< span class = "string" > "\""< / span > .value(< span class = "string" > "\""< / span > ),
< span class = "string" > "n"< / span > .value(< span class = "string" > "\n"< / span > ),
))
).parse_next(input)
}
< span class = "macro" > assert_eq!< / span > (parser.parse_peek(Partial::new(< span class = "string" > "ab\\\"cd\""< / span > )), < span class = "prelude-val" > Ok< / span > ((Partial::new(< span class = "string" > "\""< / span > ), String::from(< span class = "string" > "ab\"cd"< / span > ))));< / code > < / pre > < / div >
< / div > < / details > < / section > < / div > < / main > < / body > < / html >
