2024-08-01 07:04:26 +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 = "Terminal styling definitions" > < title > Styles in clap::builder - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . head . insertAdjacentHTML ( "beforeend" , "SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../../static.files/rustdoc-dd39b87e5fcfba68.css" > < meta name = "rustdoc-vars" data-root-path = "../../" data-static-root-path = "../../static.files/" data-current-crate = "clap" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.80.0 (051478957 2024-07-21)" data-channel = "1.80.0" data-search-js = "search-d52510db62a78183.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../../static.files/storage-118b08c4c78b968e.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../../static.files/main-20a3ad099b048cf2.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../static.files/noscript-df360f571f6edeae.css" > < / noscript > < 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 struct" > <!-- [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 = "../../clap/index.html" > < img src = "https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt = "" > < / a > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < a class = "logo-container" href = "../../clap/index.html" > < img src = "https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt = "logo" > < / a > < h2 > < a href = "../../clap/index.html" > clap< / a > < span class = "version" > 4.5.13< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > Styles< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#implementations" > Methods< / a > < / h3 > < ul class = "block method" > < li > < a href = "#method.error" > error< / a > < / li > < li > < a href = "#method.get_error" > get_error< / a > < / li > < li > < a href = "#method.get_header" > get_header< / a > < / li > < li > < a href = "#method.get_invalid" > get_invalid< / a > < / li > < li > < a href = "#method.get_literal" > get_literal< / a > < / li > < li > < a href = "#method.get_placeholder" > get_placeholder< / a > < / li > < li > < a href = "#method.get_usage" > get_usage< / a > < / li > < li > < a href = "#method.get_valid" > get_valid< / a > < / li > < li > < a href = "#method.header" > header< / a > < / li > < li > < a href = "#method.invalid" > invalid< / a > < / li > < li > < a href = "#method.literal" > literal< / a > < / li > < li > < a href = "#method.placeholder" > placeholder< / a > < / li > < li > < a href = "#method.plain" > plain< / a > < / li > < li > < a href = "#method.styled" > styled< / a > < / li > < li > < a href = "#method.usage" > usage< / a > < / li > < li > < a href = "#method.valid" > valid< / a > < / li > < / ul > < h3 > < a href = "#trait-implementations" > Trait Implementations< / a > < / h3 > < ul class = "block trait-implementation" > < li > < a href = "#impl-Clone-for-Styles" > Clone< / a > < / li > < li > < a href = "#impl-Debug-for-Styles" > Debug< / a > < / li > < li > < a href = "#impl-Default-for-%26Styles" > Default< / a > < / li > < li > < a href = "#impl-Default-for-Styles" > Default< / a > < / li > < / ul > < h3 > < a href = "#synthetic-implementations" > Auto Trait Implementations< / a > < / h3 > < ul class = "block synthetic-implementation" > < li > < a href = "#impl-Freeze-for-Styles" > Freeze< / a > < / li > < li > < a href = "#impl-RefUnwindSafe-for-Styles" > RefUnwindSafe< / a > < / li > < li > < a href = "#impl-Send-for-Styles" > Send< / a > < / li > < li > < a href = "#impl-Sync-for-Styles" > Sync< / a > < / li > < li > < a href = "#impl-Unpin-for-Styles" > Unpin< / a > < / li > < li > < a href = "#impl-UnwindSafe-for-Styles" >
2024-02-13 06:38:44 +00:00
< p > See also < a href = "../struct.Command.html#method.styles" title = "method clap::Command::styles" > < code > Command::styles< / code > < / a > .< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "example" > < a class = "doc-anchor" href = "#example" > §< / a > Example< / h2 >
2024-02-13 06:38:44 +00:00
< p > clap v3 styling< / p >
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > let < / span > styles = Styles::styled()
.header(AnsiColor::Yellow.on_default())
.usage(AnsiColor::Green.on_default())
.literal(AnsiColor::Green.on_default())
.placeholder(AnsiColor::Green.on_default());< / code > < / pre > < / div >
< / div > < / details > < h2 id = "implementations" class = "section-header" > Implementations< a href = "#implementations" class = "anchor" > §< / a > < / h2 > < div id = "implementations-list" > < details class = "toggle implementors-toggle" open > < summary > < section id = "impl-Styles" class = "impl" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#33" > source< / a > < a href = "#impl-Styles" class = "anchor" > §< / a > < h3 class = "code-header" > impl < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.plain" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#35" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.plain" class = "fn" > plain< / a > () -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > No terminal styling< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.styled" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#48" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.styled" class = "fn" > styled< / a > () -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Default terminal styling< / p >
2024-07-26 09:42:18 +00:00
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.header" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#71" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.header" class = "fn" > header< / a > (self, style: < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > ) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > General Heading style, e.g. < a href = "../struct.Arg.html#method.help_heading" title = "method clap::Arg::help_heading" > < code > help_heading< / code > < / a > < / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.error" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#78" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.error" class = "fn" > error< / a > (self, style: < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > ) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Error heading< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.usage" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#85" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.usage" class = "fn" > usage< / a > (self, style: < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > ) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Usage heading< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.literal" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#92" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.literal" class = "fn" > literal< / a > (self, style: < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > ) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Literal command-line syntax, e.g. < code > --help< / code > < / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.placeholder" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#99" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.placeholder" class = "fn" > placeholder< / a > (self, style: < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > ) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Descriptions within command-line syntax, e.g. < a href = "../struct.Arg.html#method.value_name" title = "method clap::Arg::value_name" > < code > value_name< / code > < / a > < / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.valid" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#106" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.valid" class = "fn" > valid< / a > (self, style: < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > ) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Highlight suggested usage< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.invalid" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#113" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.invalid" class = "fn" > invalid< / a > (self, style: < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > ) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Highlight invalid usage< / p >
< / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" open > < summary > < section id = "impl-Styles-1" class = "impl" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#120" > source< / a > < a href = "#impl-Styles-1" class = "anchor" > §< / a > < h3 class = "code-header" > impl < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h3 > < / section > < / summary > < div class = "docblock" > < p > Reflection< / p >
< / div > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.get_header" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#123" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.get_header" class = "fn" > get_header< / a > (& self) -> & < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > General Heading style, e.g. < a href = "../struct.Arg.html#method.help_heading" title = "method clap::Arg::help_heading" > < code > help_heading< / code > < / a > < / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.get_error" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#129" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.get_error" class = "fn" > get_error< / a > (& self) -> & < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Error heading< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.get_usage" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#135" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.get_usage" class = "fn" > get_usage< / a > (& self) -> & < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Usage heading< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.get_literal" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#141" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.get_literal" class = "fn" > get_literal< / a > (& self) -> & < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Literal command-line syntax, e.g. < code > --help< / code > < / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.get_placeholder" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#147" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.get_placeholder" class = "fn" > get_placeholder< / a > (& self) -> & < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Descriptions within command-line syntax, e.g. < a href = "../struct.Arg.html#method.value_name" title = "method clap::Arg::value_name" > < code > value_name< / code > < / a > < / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.get_valid" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#153" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.get_valid" class = "fn" > get_valid< / a > (& self) -> & < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Highlight suggested usage< / p >
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.get_invalid" class = "method" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#159" > source< / a > < h4 class = "code-header" > pub const fn < a href = "#method.get_invalid" class = "fn" > get_invalid< / a > (& self) -> & < a class = "struct" href = "styling/struct.Style.html" title = "struct clap::builder::styling::Style" > Style< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Highlight invalid usage< / p >
2024-08-01 07:04:26 +00:00
< / div > < / details > < / div > < / details > < / div > < h2 id = "trait-implementations" class = "section-header" > Trait Implementations< a href = "#trait-implementations" class = "anchor" > §< / a > < / h2 > < div id = "trait-implementations-list" > < details class = "toggle implementors-toggle" open > < summary > < section id = "impl-Clone-for-Styles" class = "impl" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#21" > source< / a > < a href = "#impl-Clone-for-Styles" class = "anchor" > §< / a > < h3 class = "code-header" > impl < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title = "trait core::clone::Clone" > Clone< / a > for < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.clone" class = "method trait-impl" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#21" > source< / a > < a href = "#method.clone" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone" class = "fn" > clone< / a > (& self) -> < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > Returns a copy of the value. < a href = "https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone" > Read more< / a > < / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.clone_from" class = "method trait-impl" > < span class = "rightside" > < span class = "since" title = "Stable since Rust version 1.0.0" > 1.0.0< / span > · < a class = "src" href = "https://doc.rust-lang.org/1.80.0/src/core/clone.rs.html#169" > source< / a > < / span > < a href = "#method.clone_from" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from" class = "fn" > clone_from< / a > (& mut self, source: < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.reference.html" > & Self< / a > )< / h4 > < / section > < / summary > < div class = 'docblock' > Performs copy-assignment from < code > source< / code > . < a href = "https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" open > < summary > < section id = "impl-Debug-for-Styles" class = "impl" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#21" > source< / a > < a href = "#impl-Debug-for-Styles" class = "anchor" > §< / a > < h3 class = "code-header" > impl < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title = "trait core::fmt::Debug" > Debug< / a > for < a class = "struct" href = "struct.Styles.html" title = "struct clap::builder::Styles" > Styles< / a > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.fmt" class = "method trait-impl" > < a class = "src rightside" href = "../../src/clap_builder/builder/styling.rs.html#21" > source< / a > < a href = "#method.fmt" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class = "fn" > fmt< / a > (& self, f: & mut < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title = "struct core::fmt::Formatter" > Formatter< / a > < '_> ) -> < a class = "enum" href = "https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.unit.html" > ()< / a > , < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/core/fmt/struct.Error.html" title = "struct core::fmt::Error" > Error< / a > > < / h4 > < / section > < / summary > < div class = 'docblock' > Formats the value using the given formatter. < a href = "https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" open > < summary > < section id = "impl-Default-for-%26Styles" class = "impl" > < a class = "src r
2024-07-26 09:42:18 +00:00
T: 'static + ?< a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.type_id" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#141" > source< / a > < a href = "#method.type_id" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" class = "fn" > type_id< / a > (& self) -> < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/core/any/struct.TypeId.html" title = "struct core::any::TypeId" > TypeId< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > Gets the < code > TypeId< / code > of < code > self< / code > . < a href = "https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-Borrow%3CT%3E-for-T" class = "impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#208" > source< / a > < a href = "#impl-Borrow%3CT%3E-for-T" class = "anchor" > §< / a > < h3 class = "code-header" > impl< T> < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title = "trait core::borrow::Borrow" > Borrow< / a > < T> for T< div class = "where" > where
T: ?< a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.borrow" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#210" > source< / a > < a href = "#method.borrow" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class = "fn" > borrow< / a > (& self) -> < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.reference.html" > & T< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > Immutably borrows from an owned value. < a href = "https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-BorrowMut%3CT%3E-for-T" class = "impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#216" > source< / a > < a href = "#impl-BorrowMut%3CT%3E-for-T" class = "anchor" > §< / a > < h3 class = "code-header" > impl< T> < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title = "trait core::borrow::BorrowMut" > BorrowMut< / a > < T> for T< div class = "where" > where
T: ?< a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.borrow_mut" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#217" > source< / a > < a href = "#method.borrow_mut" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class = "fn" > borrow_mut< / a > (& mut self) -> < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.reference.html" > & mut T< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > Mutably borrows from an owned value. < a href = "https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-From%3CT%3E-for-T" class = "impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#765" > source< / a > < a href = "#impl-From%3CT%3E-for-T" class = "anchor" > §< / a > < h3 class = "code-header" > impl< T> < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title = "trait core::convert::From" > From< / a > < T> for T< / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.from" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768" > source< / a > < a href = "#method.from" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" class = "fn" > from< / a > (t: T) -> T< / h4 > < / section > < / summary > < div class = "docblock" > < p > Returns the argument unchanged.< / p >
< / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-Into%3CU%3E-for-T" class = "impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#748-750" > source< / a > < a href = "#impl-Into%3CU%3E-for-T" class = "anchor" > §< / a > < h3 class = "code-header" > impl< T, U> < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < U> for T< div class = "where" > where
U: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title = "trait core::convert::From" > From< / a > < T> ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle method-toggle" open > < summary > < section id = "method.into" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#758" > source< / a > < a href = "#method.into" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html#tymethod.into" class = "fn" > into< / a > (self) -> U< / h4 > < / section > < / summary > < div class = "docblock" > < p > Calls < code > U::from(self)< / code > .< / p >
2024-02-13 06:38:44 +00:00
< p > That is, this conversion is whatever the implementation of
2024-07-26 09:42:18 +00:00
< code > < a href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title = "trait core::convert::From" > From< / a > < T> for U< / code > chooses to do.< / p >
< / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-ToOwned-for-T" class = "impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#83-85" > source< / a > < a href = "#impl-ToOwned-for-T" class = "anchor" > §< / a > < h3 class = "code-header" > impl< T> < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html" title = "trait alloc::borrow::ToOwned" > ToOwned< / a > for T< div class = "where" > where
T: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title = "trait core::clone::Clone" > Clone< / a > ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle" open > < summary > < section id = "associatedtype.Owned" class = "associatedtype trait-impl" > < a href = "#associatedtype.Owned" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class = "associatedtype" > Owned< / a > = T< / h4 > < / section > < / summary > < div class = 'docblock' > The resulting type after obtaining ownership.< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.to_owned" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#88" > source< / a > < a href = "#method.to_owned" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class = "fn" > to_owned< / a > (& self) -> T< / h4 > < / section > < / summary > < div class = 'docblock' > Creates owned data from borrowed data, usually by cloning. < a href = "https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" > Read more< / a > < / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.clone_into" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#92" > source< / a > < a href = "#method.clone_into" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class = "fn" > clone_into< / a > (& self, target: < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.reference.html" > & mut T< / a > )< / h4 > < / section > < / summary > < div class = 'docblock' > Uses borrowed data to replace owned data, usually by cloning. < a href = "https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-TryFrom%3CU%3E-for-T" class = "impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#805-807" > source< / a > < a href = "#impl-TryFrom%3CU%3E-for-T" class = "anchor" > §< / a > < h3 class = "code-header" > impl< T, U> < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title = "trait core::convert::TryFrom" > TryFrom< / a > < U> for T< div class = "where" > where
U: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < T> ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle" open > < summary > < section id = "associatedtype.Error" class = "associatedtype trait-impl" > < a href = "#associatedtype.Error" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class = "associatedtype" > Error< / a > = < a class = "enum" href = "https://doc.rust-lang.org/1.80.0/core/convert/enum.Infallible.html" title = "enum core::convert::Infallible" > Infallible< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > The type returned in the event of a conversion error.< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.try_from" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#812" > source< / a > < a href = "#method.try_from" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from" class = "fn" > try_from< / a > (value: U) -> < a class = "enum" href = "https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < T, < T as < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title = "trait core::convert::TryFrom" > TryFrom< / a > < U> > ::< a class = "associatedtype" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title = "type core::convert::TryFrom::Error" > Error< / a > > < / h4 > < / section > < / summary > < div class = 'docblock' > Performs the conversion.< / div > < / details > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-TryInto%3CU%3E-for-T" class = "impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#790-792" > source< / a > < a href = "#impl-TryInto%3CU%3E-for-T" class = "anchor" > §< / a > < h3 class = "code-header" > impl< T, U> < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title = "trait core::convert::TryInto" > TryInto< / a > < U> for T< div class = "where" > where
U: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title = "trait core::convert::TryFrom" > TryFrom< / a > < T> ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "toggle" open > < summary > < section id = "associatedtype.Error-1" class = "associatedtype trait-impl" > < a href = "#associatedtype.Error-1" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class = "associatedtype" > Error< / a > = < U as < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title = "trait core::convert::TryFrom" > TryFrom< / a > < T> > ::< a class = "associatedtype" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title = "type core::convert::TryFrom::Error" > Error< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > The type returned in the event of a conversion error.< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.try_into" class = "method trait-impl" > < a class = "src rightside" href = "https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#797" > source< / a > < a href = "#method.try_into" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class = "fn" > try_into< / a > (self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < U, < U as < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title = "trait core::convert::TryFrom" > TryFrom< / a > < T> > ::< a class = "associatedtype" href = "https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title = "type core::convert::TryFrom::Error" > Error< / a > > < / h4 > < / section > < / summary > < div class = 'docblock' > Performs the conversion.< / div > < / details > < / div > < / details > < / div > < / section > < / div > < / main > < / body > < / html >
