diff --git a/anyhow/all.html b/anyhow/all.html index 8e731034c..d18065f36 100644 --- a/anyhow/all.html +++ b/anyhow/all.html @@ -1,2 +1,2 @@ -List of all items in this crate
+List of all items in this crate

List of all items

Structs

Traits

Macros

Functions

Type Aliases

\ No newline at end of file diff --git a/anyhow/fn.Ok.html b/anyhow/fn.Ok.html index a29f425ba..c22819334 100644 --- a/anyhow/fn.Ok.html +++ b/anyhow/fn.Ok.html @@ -1,4 +1,4 @@ -Ok in anyhow - Rust
+Ok in anyhow - Rust

Function anyhow::Ok

source · 
pub fn Ok<T>(t: T) -> Result<T>
Expand description

Equivalent to Ok::<_, anyhow::Error>(value).

This simplifies creation of an anyhow::Result in places where type inference cannot deduce the E type of the result — without needing to write diff --git a/anyhow/index.html b/anyhow/index.html index 666b6b9a8..ef25d8a5a 100644 --- a/anyhow/index.html +++ b/anyhow/index.html @@ -1,4 +1,4 @@ -anyhow - Rust

source

pub fn downcast_mut<E>(&mut self) -> Option<&mut E>
where E: Display + Debug + Send + Sync + 'static,

Downcast this error object by mutable reference.

-

Trait Implementations§

source§

impl AsRef<dyn Error> for Error

source§

fn as_ref(&self) -> &(dyn StdError + 'static)

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<dyn Error + Send + Sync> for Error

source§

fn as_ref(&self) -> &(dyn StdError + Send + Sync + 'static)

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Debug for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Deref for Error

§

type Target = dyn Error + Send + Sync

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for Error

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl Display for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Error

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<E> From<E> for Error
where - E: StdError + Send + Sync + 'static,

source§

fn from(error: E) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Box<dyn StdError + 'static>

source§

fn from(error: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Box<dyn StdError + Send + 'static>

source§

fn from(error: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Box<dyn StdError + Send + Sync + 'static>

source§

fn from(error: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl AsRef<dyn Error> for Error

source§

fn as_ref(&self) -> &(dyn StdError + 'static)

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<dyn Error + Send + Sync> for Error

source§

fn as_ref(&self) -> &(dyn StdError + Send + Sync + 'static)

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Debug for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Deref for Error

§

type Target = dyn Error + Send + Sync

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for Error

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl Display for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Error

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<E> From<E> for Error
where + E: StdError + Send + Sync + 'static,

source§

fn from(error: E) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Box<dyn StdError + 'static>

source§

fn from(error: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Box<dyn StdError + Send + 'static>

source§

fn from(error: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Box<dyn StdError + Send + Sync + 'static>

source§

fn from(error: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/anyhow/trait.Context.html b/anyhow/trait.Context.html index 3cf4cd369..865389f35 100644 --- a/anyhow/trait.Context.html +++ b/anyhow/trait.Context.html @@ -1,4 +1,4 @@ -Context in anyhow - Rust
+Context in anyhow - Rust

Trait anyhow::Context

source · 
pub trait Context<T, E>: Sealed {
     // Required methods
     fn context<C>(self, context: C) -> Result<T, Error>
diff --git a/anyhow/type.Result.html b/anyhow/type.Result.html
index 6a15cfe59..03557878e 100644
--- a/anyhow/type.Result.html
+++ b/anyhow/type.Result.html
@@ -1,4 +1,4 @@
-Result in anyhow - Rust

+Result in anyhow - Rust

     
Type Alias anyhow::Result
source · 
pub type Result<T, E = Error> = Result<T, E>;
Expand description
Result<T, Error>

 
This is a reasonable return type to use throughout your application but also
 for fn main; if you do, failures will be printed along with any
diff --git a/edlang_check/fn.lowering_error_to_report.html b/edlang_check/fn.lowering_error_to_report.html
index 384d51477..c552ad184 100644
--- a/edlang_check/fn.lowering_error_to_report.html
+++ b/edlang_check/fn.lowering_error_to_report.html
@@ -1,5 +1,5 @@
 lowering_error_to_report in edlang_check - Rust

-    
Function edlang_check::lowering_error_to_report
source · 
pub fn lowering_error_to_report(
+    
Function edlang_check::lowering_error_to_report
source · 
pub fn lowering_error_to_report(
     error: LoweringError,
     session: &Session
 ) -> Report<'_, (String, Range<usize>)>
Expand description
Creates a report from a lowering error.

diff --git a/edlang_check/index.html b/edlang_check/index.html
index 65f2c06b1..9bc271b4e 100644
--- a/edlang_check/index.html
+++ b/edlang_check/index.html
@@ -1,3 +1,3 @@
 edlang_check - Rust

-    
Crate edlang_check
source · 
Functions§

\ No newline at end of file
+    
Crate edlang_check
source · 
Functions§

\ No newline at end of file
diff --git a/edlang_lowering/errors/enum.LoweringError.html b/edlang_lowering/errors/enum.LoweringError.html
index 1d688b236..bf518cef7 100644
--- a/edlang_lowering/errors/enum.LoweringError.html
+++ b/edlang_lowering/errors/enum.LoweringError.html
@@ -1,5 +1,5 @@
-LoweringError in edlang_lowering::errors - Rust

-    
Enum edlang_lowering::errors::LoweringError
source · 
pub enum LoweringError {
+LoweringError in edlang_lowering::errors - Rust

+    
Enum edlang_lowering::errors::LoweringError
source · 
pub enum LoweringError {
     ModuleNotFound {
         span: Span,
         module: String,
@@ -48,7 +48,13 @@
         name: String,
         file_id: usize,
     },
-}
Variants§
§
ModuleNotFound
Fields
§span: Span
§module: String
§file_id: usize
§
FunctionNotFound
Fields
§span: Span
§function: String
§file_id: usize
§
ImportNotFound
Fields
§module_span: Span
§import_span: Span
§symbol: Ident
§file_id: usize
§
BorrowNotMutable
Fields
§span: Span
§type_span: Option<Span>
§name: String
§file_id: usize
§
UnrecognizedType
Fields
§span: Span
§name: String
§file_id: usize
§
IdNotFound
Fields
§span: Span
§id: DefId
§file_id: usize
§
NotYetImplemented
Fields
§span: Span
§message: &'static str
§file_id: usize
§
UnexpectedType
Fields
§span: Span
§found: TypeKind
§expected: TypeInfo
§file_id: usize
§
UseOfUndeclaredVariable
Fields
§span: Span
§name: String
§file_id: usize
Trait Implementations§
source§
impl Clone for LoweringError
source§
fn clone(&self) -> LoweringError
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for LoweringError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for LoweringError
source§
fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for LoweringError
1.30.0 · source§
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
 Read more
1.0.0 · source§
fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§
fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+    ParamCountMismatch {
+        span: Span,
+        has_args: usize,
+        needs: usize,
+        file_id: usize,
+    },
+}
Variants§
§
ModuleNotFound
Fields
§span: Span
§module: String
§file_id: usize
§
FunctionNotFound
Fields
§span: Span
§function: String
§file_id: usize
§
ImportNotFound
Fields
§module_span: Span
§import_span: Span
§symbol: Ident
§file_id: usize
§
BorrowNotMutable
Fields
§span: Span
§type_span: Option<Span>
§name: String
§file_id: usize
§
UnrecognizedType
Fields
§span: Span
§name: String
§file_id: usize
§
IdNotFound
Fields
§span: Span
§id: DefId
§file_id: usize
§
NotYetImplemented
Fields
§span: Span
§message: &'static str
§file_id: usize
§
UnexpectedType
Fields
§span: Span
§found: TypeKind
§expected: TypeInfo
§file_id: usize
§
UseOfUndeclaredVariable
Fields
§span: Span
§name: String
§file_id: usize
§
ParamCountMismatch
Fields
§span: Span
§has_args: usize
§needs: usize
§file_id: usize
Trait Implementations§
source§
impl Clone for LoweringError
source§
fn clone(&self) -> LoweringError
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for LoweringError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for LoweringError
source§
fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for LoweringError
1.30.0 · source§
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
 Read more
1.0.0 · source§
fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§
fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_lowering/errors/index.html b/edlang_lowering/errors/index.html
index 729e21bfa..961e2eeaf 100644
--- a/edlang_lowering/errors/index.html
+++ b/edlang_lowering/errors/index.html
@@ -1,2 +1,2 @@
 edlang_lowering::errors - Rust

-    
Module edlang_lowering::errors
source · 
Enums§

\ No newline at end of file
+    
Module edlang_lowering::errors
source · 
Enums§

\ No newline at end of file
diff --git a/edlang_lowering/fn.lower_type.html b/edlang_lowering/fn.lower_type.html
index 922eea56e..4dfc53016 100644
--- a/edlang_lowering/fn.lower_type.html
+++ b/edlang_lowering/fn.lower_type.html
@@ -1,5 +1,5 @@
 lower_type in edlang_lowering - Rust

-    
Function edlang_lowering::lower_type
source · 
pub fn lower_type(
+    
Function edlang_lowering::lower_type
source · 
pub fn lower_type(
     ctx: &BuildCtx,
     t: &Type,
     module_id: DefId
diff --git a/edlang_lowering/index.html b/edlang_lowering/index.html
index ac9e2bc60..d12c29527 100644
--- a/edlang_lowering/index.html
+++ b/edlang_lowering/index.html
@@ -1,3 +1,3 @@
 edlang_lowering - Rust

-    
Crate edlang_lowering
source · 
Modules§
Functions§

\ No newline at end of file
+    
Crate edlang_lowering
source · 
Modules§
Functions§

\ No newline at end of file
diff --git a/edlang_parser/grammar/grammar/struct.BinaryFirstLvlOpParser.html b/edlang_parser/grammar/grammar/struct.BinaryFirstLvlOpParser.html
index 1ea9ce863..4b851ee41 100644
--- a/edlang_parser/grammar/grammar/struct.BinaryFirstLvlOpParser.html
+++ b/edlang_parser/grammar/grammar/struct.BinaryFirstLvlOpParser.html
@@ -1,9 +1,9 @@
 BinaryFirstLvlOpParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::BinaryFirstLvlOpParser
source · 
pub struct BinaryFirstLvlOpParser { /* private fields */ }
Implementations§
source§
impl BinaryFirstLvlOpParser
source
pub fn new() -> BinaryFirstLvlOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::BinaryFirstLvlOpParser
source · 
pub struct BinaryFirstLvlOpParser { /* private fields */ }
Implementations§
source§
impl BinaryFirstLvlOpParser
source
pub fn new() -> BinaryFirstLvlOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<BinaryOp, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for BinaryFirstLvlOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for BinaryFirstLvlOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/struct.BinarySecondLvlOpParser.html b/edlang_parser/grammar/grammar/struct.BinarySecondLvlOpParser.html
index aa02d384f..926f1cadd 100644
--- a/edlang_parser/grammar/grammar/struct.BinarySecondLvlOpParser.html
+++ b/edlang_parser/grammar/grammar/struct.BinarySecondLvlOpParser.html
@@ -1,9 +1,9 @@
 BinarySecondLvlOpParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::BinarySecondLvlOpParser
source · 
pub struct BinarySecondLvlOpParser { /* private fields */ }
Implementations§
source§
impl BinarySecondLvlOpParser
source
pub fn new() -> BinarySecondLvlOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::BinarySecondLvlOpParser
source · 
pub struct BinarySecondLvlOpParser { /* private fields */ }
Implementations§
source§
impl BinarySecondLvlOpParser
source
pub fn new() -> BinarySecondLvlOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<BinaryOp, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for BinarySecondLvlOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for BinarySecondLvlOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/struct.BinaryThirdLvlOpParser.html b/edlang_parser/grammar/grammar/struct.BinaryThirdLvlOpParser.html
index 961c7daeb..aa644624f 100644
--- a/edlang_parser/grammar/grammar/struct.BinaryThirdLvlOpParser.html
+++ b/edlang_parser/grammar/grammar/struct.BinaryThirdLvlOpParser.html
@@ -1,9 +1,9 @@
 BinaryThirdLvlOpParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::BinaryThirdLvlOpParser
source · 
pub struct BinaryThirdLvlOpParser { /* private fields */ }
Implementations§
source§
impl BinaryThirdLvlOpParser
source
pub fn new() -> BinaryThirdLvlOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::BinaryThirdLvlOpParser
source · 
pub struct BinaryThirdLvlOpParser { /* private fields */ }
Implementations§
source§
impl BinaryThirdLvlOpParser
source
pub fn new() -> BinaryThirdLvlOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<BinaryOp, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for BinaryThirdLvlOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for BinaryThirdLvlOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/struct.ModuleParser.html b/edlang_parser/grammar/grammar/struct.ModuleParser.html
index dd2f87bdb..5453e6c5d 100644
--- a/edlang_parser/grammar/grammar/struct.ModuleParser.html
+++ b/edlang_parser/grammar/grammar/struct.ModuleParser.html
@@ -1,9 +1,9 @@
 ModuleParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::ModuleParser
source · 
pub struct ModuleParser { /* private fields */ }
Implementations§
source§
impl ModuleParser
source
pub fn new() -> ModuleParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::ModuleParser
source · 
pub struct ModuleParser { /* private fields */ }
Implementations§
source§
impl ModuleParser
source
pub fn new() -> ModuleParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<Module, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for ModuleParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for ModuleParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/struct.PathSegmentsParser.html b/edlang_parser/grammar/grammar/struct.PathSegmentsParser.html
index 7ce163d2a..e0c85a4d2 100644
--- a/edlang_parser/grammar/grammar/struct.PathSegmentsParser.html
+++ b/edlang_parser/grammar/grammar/struct.PathSegmentsParser.html
@@ -1,9 +1,9 @@
 PathSegmentsParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::PathSegmentsParser
source · 
pub struct PathSegmentsParser { /* private fields */ }
Implementations§
source§
impl PathSegmentsParser
source
pub fn new() -> PathSegmentsParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::PathSegmentsParser
source · 
pub struct PathSegmentsParser { /* private fields */ }
Implementations§
source§
impl PathSegmentsParser
source
pub fn new() -> PathSegmentsParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<Vec<PathSegment>, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for PathSegmentsParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for PathSegmentsParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/struct.StructImplParser.html b/edlang_parser/grammar/grammar/struct.StructImplParser.html
index 3e0dab6e2..e96cd454f 100644
--- a/edlang_parser/grammar/grammar/struct.StructImplParser.html
+++ b/edlang_parser/grammar/grammar/struct.StructImplParser.html
@@ -1,9 +1,9 @@
 StructImplParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::StructImplParser
source · 
pub struct StructImplParser { /* private fields */ }
Implementations§
source§
impl StructImplParser
source
pub fn new() -> StructImplParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::StructImplParser
source · 
pub struct StructImplParser { /* private fields */ }
Implementations§
source§
impl StructImplParser
source
pub fn new() -> StructImplParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<StructImpl, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for StructImplParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for StructImplParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/struct.TopLevelModuleParser.html b/edlang_parser/grammar/grammar/struct.TopLevelModuleParser.html
index 1cd0581e1..946e8d285 100644
--- a/edlang_parser/grammar/grammar/struct.TopLevelModuleParser.html
+++ b/edlang_parser/grammar/grammar/struct.TopLevelModuleParser.html
@@ -1,9 +1,9 @@
 TopLevelModuleParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::TopLevelModuleParser
source · 
pub struct TopLevelModuleParser { /* private fields */ }
Implementations§
source§
impl TopLevelModuleParser
source
pub fn new() -> TopLevelModuleParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::TopLevelModuleParser
source · 
pub struct TopLevelModuleParser { /* private fields */ }
Implementations§
source§
impl TopLevelModuleParser
source
pub fn new() -> TopLevelModuleParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<Module, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for TopLevelModuleParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for TopLevelModuleParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/struct.UnaryOpParser.html b/edlang_parser/grammar/grammar/struct.UnaryOpParser.html
index 50e34b686..064e81531 100644
--- a/edlang_parser/grammar/grammar/struct.UnaryOpParser.html
+++ b/edlang_parser/grammar/grammar/struct.UnaryOpParser.html
@@ -1,9 +1,9 @@
 UnaryOpParser in edlang_parser::grammar::grammar - Rust

-    
Struct edlang_parser::grammar::grammar::UnaryOpParser
source · 
pub struct UnaryOpParser { /* private fields */ }
Implementations§
source§
impl UnaryOpParser
source
pub fn new() -> UnaryOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
+    
Struct edlang_parser::grammar::grammar::UnaryOpParser
source · 
pub struct UnaryOpParser { /* private fields */ }
Implementations§
source§
impl UnaryOpParser
source
pub fn new() -> UnaryOpParser
source
pub fn parse<'module_name, __TOKEN: __ToTriple<'module_name>, __TOKENS: IntoIterator<Item = __TOKEN>>(
     &self,
     module_name: &'module_name str,
     __tokens0: __TOKENS
-) -> Result<UnaryOp, ParseError<usize, Token, LexicalError>>
Trait Implementations§
source§
impl Default for UnaryOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
Trait Implementations§
source§
impl Default for UnaryOpParser
source§
fn default() -> Self
Returns the “default value” for a type. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/edlang_parser/grammar/grammar/trait.__ToTriple.html b/edlang_parser/grammar/grammar/trait.__ToTriple.html
index 2ffa320a6..4bb85c3f1 100644
--- a/edlang_parser/grammar/grammar/trait.__ToTriple.html
+++ b/edlang_parser/grammar/grammar/trait.__ToTriple.html
@@ -1,13 +1,13 @@
 __ToTriple in edlang_parser::grammar::grammar - Rust

-    
Trait edlang_parser::grammar::grammar::__ToTriple
source · 
pub trait __ToTriple<'module_name> {
+    
Trait edlang_parser::grammar::grammar::__ToTriple
source · 
pub trait __ToTriple<'module_name> {
     // Required method
     fn to_triple(
         value: Self
     ) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>;
-}
Required Methods§
source
fn to_triple(
+}
Required Methods§
source
fn to_triple(
     value: Self
-) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>
Object Safety§
This trait is not object safe.
Implementations on Foreign Types§
source§
impl<'module_name> __ToTriple<'module_name> for (usize, Token, usize)
source§
fn to_triple(
+) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>
Object Safety§
This trait is not object safe.
Implementations on Foreign Types§
source§
impl<'module_name> __ToTriple<'module_name> for (usize, Token, usize)
source§
fn to_triple(
     value: Self
-) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>
source§
impl<'module_name> __ToTriple<'module_name> for Result<(usize, Token, usize), LexicalError>
source§
fn to_triple(
+) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>
source§
impl<'module_name> __ToTriple<'module_name> for Result<(usize, Token, usize), LexicalError>
source§
fn to_triple(
     value: Self
 ) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>
Implementors§

\ No newline at end of file
diff --git a/git2/struct.AttrCheckFlags.html b/git2/struct.AttrCheckFlags.html
index 8b3a26091..81a6d0326 100644
--- a/git2/struct.AttrCheckFlags.html
+++ b/git2/struct.AttrCheckFlags.html
@@ -37,12 +37,12 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<AttrCheckFlags>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
Trait Implementations§
source§
impl Binary for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for AttrCheckFlags
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
Trait Implementations§
source§
impl Binary for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for AttrCheckFlags
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

 
§
type Output = AttrCheckFlags
The resulting type after applying the & operator.
source§
impl BitAndAssign for AttrCheckFlags
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for AttrCheckFlags
source§
fn bitor(self, other: AttrCheckFlags) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = AttrCheckFlags
The resulting type after applying the | operator.
source§
impl BitOrAssign for AttrCheckFlags
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = AttrCheckFlags
The resulting type after applying the | operator.
source§
impl BitOrAssign for AttrCheckFlags
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for AttrCheckFlags
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = AttrCheckFlags
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for AttrCheckFlags
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
§
type Output = AttrCheckFlags
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for AttrCheckFlags
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

 
source§
impl Clone for AttrCheckFlags
source§
fn clone(&self) -> AttrCheckFlags
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Default for AttrCheckFlags
source§
fn default() -> Self
Returns the “default value” for a type. Read more
source§
impl Extend<AttrCheckFlags> for AttrCheckFlags
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for AttrCheckFlags
source§
const FLAGS: &'static [Flag<AttrCheckFlags>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> AttrCheckFlags
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
@@ -51,16 +51,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<AttrCheckFlags> for AttrCheckFlags
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for AttrCheckFlags
§
type Item = AttrCheckFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<AttrCheckFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for AttrCheckFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = AttrCheckFlags
The resulting type after applying the ! operator.
source§
impl Octal for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for AttrCheckFlags
source§
fn eq(&self, other: &AttrCheckFlags) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for AttrCheckFlags
§
type Item = AttrCheckFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<AttrCheckFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for AttrCheckFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = AttrCheckFlags
The resulting type after applying the ! operator.
source§
impl Octal for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for AttrCheckFlags
source§
fn eq(&self, other: &AttrCheckFlags) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for AttrCheckFlags
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for AttrCheckFlags
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = AttrCheckFlags
The resulting type after applying the - operator.
source§
impl SubAssign for AttrCheckFlags
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = AttrCheckFlags
The resulting type after applying the - operator.
source§
impl SubAssign for AttrCheckFlags
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for AttrCheckFlags
source§
impl Eq for AttrCheckFlags
source§
impl StructuralPartialEq for AttrCheckFlags
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for AttrCheckFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for AttrCheckFlags
source§
impl Eq for AttrCheckFlags
source§
impl StructuralPartialEq for AttrCheckFlags
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.CheckoutNotificationType.html b/git2/struct.CheckoutNotificationType.html
index 0a0e17230..757c46458 100644
--- a/git2/struct.CheckoutNotificationType.html
+++ b/git2/struct.CheckoutNotificationType.html
@@ -40,12 +40,12 @@ will be yielded together as a final flags value.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

 
source§
impl CheckoutNotificationType
source
pub fn is_conflict(&self) -> bool
source
pub fn is_dirty(&self) -> bool
source
pub fn is_updated(&self) -> bool
source
pub fn is_untracked(&self) -> bool
source
pub fn is_ignored(&self) -> bool
Trait Implementations§
source§
impl Binary for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for CheckoutNotificationType
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = CheckoutNotificationType
The resulting type after applying the & operator.
source§
impl BitAndAssign for CheckoutNotificationType
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
§
type Output = CheckoutNotificationType
The resulting type after applying the & operator.
source§
impl BitAndAssign for CheckoutNotificationType
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for CheckoutNotificationType
source§
fn bitor(self, other: CheckoutNotificationType) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = CheckoutNotificationType
The resulting type after applying the | operator.
source§
impl BitOrAssign for CheckoutNotificationType
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = CheckoutNotificationType
The resulting type after applying the | operator.
source§
impl BitOrAssign for CheckoutNotificationType
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for CheckoutNotificationType
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = CheckoutNotificationType
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for CheckoutNotificationType
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for CheckoutNotificationType
source§
fn clone(&self) -> CheckoutNotificationType
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<CheckoutNotificationType> for CheckoutNotificationType
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
§
type Output = CheckoutNotificationType
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for CheckoutNotificationType
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
source§
impl Clone for CheckoutNotificationType
source§
fn clone(&self) -> CheckoutNotificationType
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<CheckoutNotificationType> for CheckoutNotificationType
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for CheckoutNotificationType
source§
const FLAGS: &'static [Flag<CheckoutNotificationType>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> CheckoutNotificationType
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -54,7 +54,7 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<CheckoutNotificationType> for CheckoutNotificationType
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

 
source§
impl IntoIterator for CheckoutNotificationType
§
type Item = CheckoutNotificationType
The type of the elements being iterated over.
§
type IntoIter = Iter<CheckoutNotificationType>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for CheckoutNotificationType
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = CheckoutNotificationType
The resulting type after applying the ! operator.
source§
impl Octal for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for CheckoutNotificationType
source§
fn eq(&self, other: &CheckoutNotificationType) -> bool
This method tests for self and other values to be equal, and is used
+
§
type Output = CheckoutNotificationType
The resulting type after applying the ! operator.
source§
impl Octal for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for CheckoutNotificationType
source§
fn eq(&self, other: &CheckoutNotificationType) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for CheckoutNotificationType
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for CheckoutNotificationType
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
@@ -62,7 +62,7 @@ sufficient, and should not be overridden without very good reason.
§
type Output = CheckoutNotificationType
The resulting type after applying the - operator.
source§
impl SubAssign for CheckoutNotificationType
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for CheckoutNotificationType
source§
impl Eq for CheckoutNotificationType
source§
impl StructuralPartialEq for CheckoutNotificationType
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for CheckoutNotificationType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for CheckoutNotificationType
source§
impl Eq for CheckoutNotificationType
source§
impl StructuralPartialEq for CheckoutNotificationType
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.CredentialType.html b/git2/struct.CredentialType.html
index fb5305b95..283404391 100644
--- a/git2/struct.CredentialType.html
+++ b/git2/struct.CredentialType.html
@@ -34,13 +34,13 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<CredentialType>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl CredentialType
source
pub fn is_user_pass_plaintext(&self) -> bool
source
pub fn is_ssh_key(&self) -> bool
source
pub fn is_ssh_memory(&self) -> bool
source
pub fn is_ssh_custom(&self) -> bool
source
pub fn is_default(&self) -> bool
source
pub fn is_ssh_interactive(&self) -> bool
source
pub fn is_username(&self) -> bool
Trait Implementations§
source§
impl Binary for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for CredentialType
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
source§
impl CredentialType
source
pub fn is_user_pass_plaintext(&self) -> bool
source
pub fn is_ssh_key(&self) -> bool
source
pub fn is_ssh_memory(&self) -> bool
source
pub fn is_ssh_custom(&self) -> bool
source
pub fn is_default(&self) -> bool
source
pub fn is_ssh_interactive(&self) -> bool
source
pub fn is_username(&self) -> bool
Trait Implementations§
source§
impl Binary for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for CredentialType
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

 
§
type Output = CredentialType
The resulting type after applying the & operator.
source§
impl BitAndAssign for CredentialType
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for CredentialType
source§
fn bitor(self, other: CredentialType) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = CredentialType
The resulting type after applying the | operator.
source§
impl BitOrAssign for CredentialType
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = CredentialType
The resulting type after applying the | operator.
source§
impl BitOrAssign for CredentialType
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for CredentialType
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

 
§
type Output = CredentialType
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for CredentialType
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for CredentialType
source§
fn clone(&self) -> CredentialType
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Default for CredentialType
source§
fn default() -> Self
Returns the “default value” for a type. Read more
source§
impl Extend<CredentialType> for CredentialType
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
source§
impl Clone for CredentialType
source§
fn clone(&self) -> CredentialType
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Default for CredentialType
source§
fn default() -> Self
Returns the “default value” for a type. Read more
source§
impl Extend<CredentialType> for CredentialType
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for CredentialType
source§
const FLAGS: &'static [Flag<CredentialType>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> CredentialType
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -48,16 +48,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<CredentialType> for CredentialType
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for CredentialType
§
type Item = CredentialType
The type of the elements being iterated over.
§
type IntoIter = Iter<CredentialType>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for CredentialType
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = CredentialType
The resulting type after applying the ! operator.
source§
impl Octal for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for CredentialType
source§
fn eq(&self, other: &CredentialType) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for CredentialType
§
type Item = CredentialType
The type of the elements being iterated over.
§
type IntoIter = Iter<CredentialType>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for CredentialType
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = CredentialType
The resulting type after applying the ! operator.
source§
impl Octal for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for CredentialType
source§
fn eq(&self, other: &CredentialType) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for CredentialType
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for CredentialType
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = CredentialType
The resulting type after applying the - operator.
source§
impl SubAssign for CredentialType
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = CredentialType
The resulting type after applying the - operator.
source§
impl SubAssign for CredentialType
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for CredentialType
source§
impl Eq for CredentialType
source§
impl StructuralPartialEq for CredentialType
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for CredentialType
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for CredentialType
source§
impl Eq for CredentialType
source§
impl StructuralPartialEq for CredentialType
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.DiffFlags.html b/git2/struct.DiffFlags.html
index c55f4dad5..061d16847 100644
--- a/git2/struct.DiffFlags.html
+++ b/git2/struct.DiffFlags.html
@@ -38,11 +38,11 @@ will be yielded together as a final flags value.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

 
source§
impl DiffFlags
source
pub fn is_binary(&self) -> bool
source
pub fn is_not_binary(&self) -> bool
source
pub fn has_valid_id(&self) -> bool
source
pub fn exists(&self) -> bool
Trait Implementations§
source§
impl Binary for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for DiffFlags
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = DiffFlags
The resulting type after applying the & operator.
source§
impl BitAndAssign for DiffFlags
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
§
type Output = DiffFlags
The resulting type after applying the & operator.
source§
impl BitAndAssign for DiffFlags
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for DiffFlags
source§
fn bitor(self, other: DiffFlags) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = DiffFlags
The resulting type after applying the | operator.
source§
impl BitOrAssign for DiffFlags
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = DiffFlags
The resulting type after applying the | operator.
source§
impl BitOrAssign for DiffFlags
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for DiffFlags
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = DiffFlags
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for DiffFlags
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
§
type Output = DiffFlags
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for DiffFlags
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

 
source§
impl Clone for DiffFlags
source§
fn clone(&self) -> DiffFlags
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<DiffFlags> for DiffFlags
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for DiffFlags
source§
const FLAGS: &'static [Flag<DiffFlags>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> DiffFlags
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
@@ -51,16 +51,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<DiffFlags> for DiffFlags
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for DiffFlags
§
type Item = DiffFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<DiffFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for DiffFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = DiffFlags
The resulting type after applying the ! operator.
source§
impl Octal for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for DiffFlags
source§
fn eq(&self, other: &DiffFlags) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for DiffFlags
§
type Item = DiffFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<DiffFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for DiffFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = DiffFlags
The resulting type after applying the ! operator.
source§
impl Octal for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for DiffFlags
source§
fn eq(&self, other: &DiffFlags) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for DiffFlags
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for DiffFlags
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = DiffFlags
The resulting type after applying the - operator.
source§
impl SubAssign for DiffFlags
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = DiffFlags
The resulting type after applying the - operator.
source§
impl SubAssign for DiffFlags
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for DiffFlags
source§
impl Eq for DiffFlags
source§
impl StructuralPartialEq for DiffFlags
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for DiffFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for DiffFlags
source§
impl Eq for DiffFlags
source§
impl StructuralPartialEq for DiffFlags
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.DiffStatsFormat.html b/git2/struct.DiffStatsFormat.html
index f4b86e1b8..611649333 100644
--- a/git2/struct.DiffStatsFormat.html
+++ b/git2/struct.DiffStatsFormat.html
@@ -40,13 +40,13 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<DiffStatsFormat>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl DiffStatsFormat
source
pub fn is_none(&self) -> bool
source
pub fn is_full(&self) -> bool
source
pub fn is_short(&self) -> bool
source
pub fn is_number(&self) -> bool
source
pub fn is_include_summary(&self) -> bool
Trait Implementations§
source§
impl Binary for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for DiffStatsFormat
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = DiffStatsFormat
The resulting type after applying the & operator.
source§
impl BitAndAssign for DiffStatsFormat
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
source§
impl DiffStatsFormat
source
pub fn is_none(&self) -> bool
source
pub fn is_full(&self) -> bool
source
pub fn is_short(&self) -> bool
source
pub fn is_number(&self) -> bool
source
pub fn is_include_summary(&self) -> bool
Trait Implementations§
source§
impl Binary for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for DiffStatsFormat
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = DiffStatsFormat
The resulting type after applying the & operator.
source§
impl BitAndAssign for DiffStatsFormat
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for DiffStatsFormat
source§
fn bitor(self, other: DiffStatsFormat) -> Self
The bitwise or (|) of the bits in two flags values.

 
§
type Output = DiffStatsFormat
The resulting type after applying the | operator.
source§
impl BitOrAssign for DiffStatsFormat
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for DiffStatsFormat
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = DiffStatsFormat
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for DiffStatsFormat
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for DiffStatsFormat
source§
fn clone(&self) -> DiffStatsFormat
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<DiffStatsFormat> for DiffStatsFormat
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
§
type Output = DiffStatsFormat
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for DiffStatsFormat
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
source§
impl Clone for DiffStatsFormat
source§
fn clone(&self) -> DiffStatsFormat
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<DiffStatsFormat> for DiffStatsFormat
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for DiffStatsFormat
source§
const FLAGS: &'static [Flag<DiffStatsFormat>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> git_diff_stats_format_t
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: git_diff_stats_format_t) -> DiffStatsFormat
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -54,16 +54,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<DiffStatsFormat> for DiffStatsFormat
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for DiffStatsFormat
§
type Item = DiffStatsFormat
The type of the elements being iterated over.
§
type IntoIter = Iter<DiffStatsFormat>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for DiffStatsFormat
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = DiffStatsFormat
The resulting type after applying the ! operator.
source§
impl Octal for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for DiffStatsFormat
source§
fn eq(&self, other: &DiffStatsFormat) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for DiffStatsFormat
§
type Item = DiffStatsFormat
The type of the elements being iterated over.
§
type IntoIter = Iter<DiffStatsFormat>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for DiffStatsFormat
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = DiffStatsFormat
The resulting type after applying the ! operator.
source§
impl Octal for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for DiffStatsFormat
source§
fn eq(&self, other: &DiffStatsFormat) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for DiffStatsFormat
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for DiffStatsFormat
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = DiffStatsFormat
The resulting type after applying the - operator.
source§
impl SubAssign for DiffStatsFormat
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = DiffStatsFormat
The resulting type after applying the - operator.
source§
impl SubAssign for DiffStatsFormat
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for DiffStatsFormat
source§
impl Eq for DiffStatsFormat
source§
impl StructuralPartialEq for DiffStatsFormat
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for DiffStatsFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for DiffStatsFormat
source§
impl Eq for DiffStatsFormat
source§
impl StructuralPartialEq for DiffStatsFormat
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.Error.html b/git2/struct.Error.html
index 376c9bdf9..924e08074 100644
--- a/git2/struct.Error.html
+++ b/git2/struct.Error.html
@@ -36,7 +36,7 @@ or database backends, and should be used with care.

 
source
pub fn raw_code(&self) -> git_error_code
Return the raw error code associated with this error.

 
source
pub fn raw_class(&self) -> git_error_t
Return the raw error class associated with this error.

 
source
pub fn message(&self) -> &str
Return the message associated with this error

-
Trait Implementations§
source§
impl Debug for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for Error
1.30.0 · source§
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
 Read more
1.0.0 · source§
fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§
fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§
impl From<JoinPathsError> for Error
source§
fn from(e: JoinPathsError) -> Error
Converts to this type from the input type.
source§
impl From<NulError> for Error
source§
fn from(_: NulError) -> Error
Converts to this type from the input type.
source§
impl PartialEq for Error
source§
fn eq(&self, other: &Error) -> bool
This method tests for self and other values to be equal, and is used
+
Trait Implementations§
source§
impl Debug for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for Error
1.30.0 · source§
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
 Read more
1.0.0 · source§
fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§
fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§
impl From<JoinPathsError> for Error
source§
fn from(e: JoinPathsError) -> Error
Converts to this type from the input type.
source§
impl From<NulError> for Error
source§
fn from(_: NulError) -> Error
Converts to this type from the input type.
source§
impl PartialEq for Error
source§
fn eq(&self, other: &Error) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl StructuralPartialEq for Error
Auto Trait Implementations§
§
impl Freeze for Error
§
impl RefUnwindSafe for Error
§
impl Send for Error
§
impl Sync for Error
§
impl Unpin for Error
§
impl UnwindSafe for Error
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
diff --git a/git2/struct.IndexAddOption.html b/git2/struct.IndexAddOption.html
index 4a28c304d..caf5def10 100644
--- a/git2/struct.IndexAddOption.html
+++ b/git2/struct.IndexAddOption.html
@@ -34,10 +34,10 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<IndexAddOption>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl IndexAddOption
source
pub fn is_default(&self) -> bool
source
pub fn is_force(&self) -> bool
source
pub fn is_disable_pathspec_match(&self) -> bool
source
pub fn is_check_pathspec(&self) -> bool
Trait Implementations§
source§
impl Binary for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for IndexAddOption
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = IndexAddOption
The resulting type after applying the & operator.
source§
impl BitAndAssign for IndexAddOption
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
source§
impl IndexAddOption
source
pub fn is_default(&self) -> bool
source
pub fn is_force(&self) -> bool
source
pub fn is_disable_pathspec_match(&self) -> bool
source
pub fn is_check_pathspec(&self) -> bool
Trait Implementations§
source§
impl Binary for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for IndexAddOption
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = IndexAddOption
The resulting type after applying the & operator.
source§
impl BitAndAssign for IndexAddOption
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for IndexAddOption
source§
fn bitor(self, other: IndexAddOption) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = IndexAddOption
The resulting type after applying the | operator.
source§
impl BitOrAssign for IndexAddOption
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = IndexAddOption
The resulting type after applying the | operator.
source§
impl BitOrAssign for IndexAddOption
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for IndexAddOption
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

 
§
type Output = IndexAddOption
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for IndexAddOption
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

 
source§
impl Clone for IndexAddOption
source§
fn clone(&self) -> IndexAddOption
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Default for IndexAddOption
source§
fn default() -> Self
Returns the “default value” for a type. Read more
source§
impl Extend<IndexAddOption> for IndexAddOption
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

@@ -48,16 +48,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<IndexAddOption> for IndexAddOption
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for IndexAddOption
§
type Item = IndexAddOption
The type of the elements being iterated over.
§
type IntoIter = Iter<IndexAddOption>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for IndexAddOption
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = IndexAddOption
The resulting type after applying the ! operator.
source§
impl Octal for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for IndexAddOption
source§
fn eq(&self, other: &IndexAddOption) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for IndexAddOption
§
type Item = IndexAddOption
The type of the elements being iterated over.
§
type IntoIter = Iter<IndexAddOption>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for IndexAddOption
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = IndexAddOption
The resulting type after applying the ! operator.
source§
impl Octal for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for IndexAddOption
source§
fn eq(&self, other: &IndexAddOption) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for IndexAddOption
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for IndexAddOption
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = IndexAddOption
The resulting type after applying the - operator.
source§
impl SubAssign for IndexAddOption
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = IndexAddOption
The resulting type after applying the - operator.
source§
impl SubAssign for IndexAddOption
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for IndexAddOption
source§
impl Eq for IndexAddOption
source§
impl StructuralPartialEq for IndexAddOption
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for IndexAddOption
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for IndexAddOption
source§
impl Eq for IndexAddOption
source§
impl StructuralPartialEq for IndexAddOption
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.IndexEntryExtendedFlag.html b/git2/struct.IndexEntryExtendedFlag.html
index 4b8830be7..ffa63aa22 100644
--- a/git2/struct.IndexEntryExtendedFlag.html
+++ b/git2/struct.IndexEntryExtendedFlag.html
@@ -36,13 +36,13 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<IndexEntryExtendedFlag>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl IndexEntryExtendedFlag
source
pub fn is_intent_to_add(&self) -> bool
source
pub fn is_skip_worktree(&self) -> bool
source
pub fn is_up_to_date(&self) -> bool
Trait Implementations§
source§
impl Binary for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for IndexEntryExtendedFlag
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the & operator.
source§
impl BitAndAssign for IndexEntryExtendedFlag
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
source§
impl IndexEntryExtendedFlag
source
pub fn is_intent_to_add(&self) -> bool
source
pub fn is_skip_worktree(&self) -> bool
source
pub fn is_up_to_date(&self) -> bool
Trait Implementations§
source§
impl Binary for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for IndexEntryExtendedFlag
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the & operator.
source§
impl BitAndAssign for IndexEntryExtendedFlag
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for IndexEntryExtendedFlag
source§
fn bitor(self, other: IndexEntryExtendedFlag) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the | operator.
source§
impl BitOrAssign for IndexEntryExtendedFlag
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the | operator.
source§
impl BitOrAssign for IndexEntryExtendedFlag
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for IndexEntryExtendedFlag
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for IndexEntryExtendedFlag
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for IndexEntryExtendedFlag
source§
fn clone(&self) -> IndexEntryExtendedFlag
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<IndexEntryExtendedFlag> for IndexEntryExtendedFlag
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for IndexEntryExtendedFlag
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
source§
impl Clone for IndexEntryExtendedFlag
source§
fn clone(&self) -> IndexEntryExtendedFlag
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<IndexEntryExtendedFlag> for IndexEntryExtendedFlag
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for IndexEntryExtendedFlag
source§
const FLAGS: &'static [Flag<IndexEntryExtendedFlag>] = _
The set of defined flags.
§
type Bits = u16
The underlying bits type.
source§
fn bits(&self) -> u16
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u16) -> IndexEntryExtendedFlag
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -50,16 +50,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<IndexEntryExtendedFlag> for IndexEntryExtendedFlag
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for IndexEntryExtendedFlag
§
type Item = IndexEntryExtendedFlag
The type of the elements being iterated over.
§
type IntoIter = Iter<IndexEntryExtendedFlag>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for IndexEntryExtendedFlag
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the ! operator.
source§
impl Octal for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for IndexEntryExtendedFlag
source§
fn eq(&self, other: &IndexEntryExtendedFlag) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for IndexEntryExtendedFlag
§
type Item = IndexEntryExtendedFlag
The type of the elements being iterated over.
§
type IntoIter = Iter<IndexEntryExtendedFlag>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for IndexEntryExtendedFlag
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the ! operator.
source§
impl Octal for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for IndexEntryExtendedFlag
source§
fn eq(&self, other: &IndexEntryExtendedFlag) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for IndexEntryExtendedFlag
§
type Primitive = u16
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for IndexEntryExtendedFlag
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the - operator.
source§
impl SubAssign for IndexEntryExtendedFlag
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = IndexEntryExtendedFlag
The resulting type after applying the - operator.
source§
impl SubAssign for IndexEntryExtendedFlag
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for IndexEntryExtendedFlag
source§
impl Eq for IndexEntryExtendedFlag
source§
impl StructuralPartialEq for IndexEntryExtendedFlag
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for IndexEntryExtendedFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for IndexEntryExtendedFlag
source§
impl Eq for IndexEntryExtendedFlag
source§
impl StructuralPartialEq for IndexEntryExtendedFlag
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.IndexEntryFlag.html b/git2/struct.IndexEntryFlag.html
index 14d87e127..c5db34fb8 100644
--- a/git2/struct.IndexEntryFlag.html
+++ b/git2/struct.IndexEntryFlag.html
@@ -39,10 +39,10 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
 
source§
impl IndexEntryFlag
source
pub fn is_extended(&self) -> bool
source
pub fn is_valid(&self) -> bool
Trait Implementations§
source§
impl Binary for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for IndexEntryFlag
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

 
§
type Output = IndexEntryFlag
The resulting type after applying the & operator.
source§
impl BitAndAssign for IndexEntryFlag
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for IndexEntryFlag
source§
fn bitor(self, other: IndexEntryFlag) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = IndexEntryFlag
The resulting type after applying the | operator.
source§
impl BitOrAssign for IndexEntryFlag
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = IndexEntryFlag
The resulting type after applying the | operator.
source§
impl BitOrAssign for IndexEntryFlag
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for IndexEntryFlag
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

 
§
type Output = IndexEntryFlag
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for IndexEntryFlag
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for IndexEntryFlag
source§
fn clone(&self) -> IndexEntryFlag
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<IndexEntryFlag> for IndexEntryFlag
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
source§
impl Clone for IndexEntryFlag
source§
fn clone(&self) -> IndexEntryFlag
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<IndexEntryFlag> for IndexEntryFlag
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for IndexEntryFlag
source§
const FLAGS: &'static [Flag<IndexEntryFlag>] = _
The set of defined flags.
§
type Bits = u16
The underlying bits type.
source§
fn bits(&self) -> u16
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u16) -> IndexEntryFlag
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -50,16 +50,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<IndexEntryFlag> for IndexEntryFlag
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for IndexEntryFlag
§
type Item = IndexEntryFlag
The type of the elements being iterated over.
§
type IntoIter = Iter<IndexEntryFlag>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for IndexEntryFlag
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
source§
impl IntoIterator for IndexEntryFlag
§
type Item = IndexEntryFlag
The type of the elements being iterated over.
§
type IntoIter = Iter<IndexEntryFlag>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for IndexEntryFlag
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

 
§
type Output = IndexEntryFlag
The resulting type after applying the ! operator.
source§
impl Octal for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for IndexEntryFlag
source§
fn eq(&self, other: &IndexEntryFlag) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for IndexEntryFlag
§
type Primitive = u16
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for IndexEntryFlag
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = IndexEntryFlag
The resulting type after applying the - operator.
source§
impl SubAssign for IndexEntryFlag
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = IndexEntryFlag
The resulting type after applying the - operator.
source§
impl SubAssign for IndexEntryFlag
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for IndexEntryFlag
source§
impl Eq for IndexEntryFlag
source§
impl StructuralPartialEq for IndexEntryFlag
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for IndexEntryFlag
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for IndexEntryFlag
source§
impl Eq for IndexEntryFlag
source§
impl StructuralPartialEq for IndexEntryFlag
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.MergeAnalysis.html b/git2/struct.MergeAnalysis.html
index 3bda8da0c..d076fdf9c 100644
--- a/git2/struct.MergeAnalysis.html
+++ b/git2/struct.MergeAnalysis.html
@@ -45,13 +45,13 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<MergeAnalysis>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl MergeAnalysis
source
pub fn is_none(&self) -> bool
source
pub fn is_normal(&self) -> bool
source
pub fn is_up_to_date(&self) -> bool
source
pub fn is_fast_forward(&self) -> bool
source
pub fn is_unborn(&self) -> bool
Trait Implementations§
source§
impl Binary for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for MergeAnalysis
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = MergeAnalysis
The resulting type after applying the & operator.
source§
impl BitAndAssign for MergeAnalysis
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
source§
impl MergeAnalysis
source
pub fn is_none(&self) -> bool
source
pub fn is_normal(&self) -> bool
source
pub fn is_up_to_date(&self) -> bool
source
pub fn is_fast_forward(&self) -> bool
source
pub fn is_unborn(&self) -> bool
Trait Implementations§
source§
impl Binary for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for MergeAnalysis
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = MergeAnalysis
The resulting type after applying the & operator.
source§
impl BitAndAssign for MergeAnalysis
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for MergeAnalysis
source§
fn bitor(self, other: MergeAnalysis) -> Self
The bitwise or (|) of the bits in two flags values.

 
§
type Output = MergeAnalysis
The resulting type after applying the | operator.
source§
impl BitOrAssign for MergeAnalysis
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for MergeAnalysis
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = MergeAnalysis
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for MergeAnalysis
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for MergeAnalysis
source§
fn clone(&self) -> MergeAnalysis
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<MergeAnalysis> for MergeAnalysis
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
§
type Output = MergeAnalysis
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for MergeAnalysis
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
source§
impl Clone for MergeAnalysis
source§
fn clone(&self) -> MergeAnalysis
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<MergeAnalysis> for MergeAnalysis
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for MergeAnalysis
source§
const FLAGS: &'static [Flag<MergeAnalysis>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> MergeAnalysis
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -59,16 +59,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<MergeAnalysis> for MergeAnalysis
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for MergeAnalysis
§
type Item = MergeAnalysis
The type of the elements being iterated over.
§
type IntoIter = Iter<MergeAnalysis>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for MergeAnalysis
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = MergeAnalysis
The resulting type after applying the ! operator.
source§
impl Octal for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for MergeAnalysis
source§
fn eq(&self, other: &MergeAnalysis) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for MergeAnalysis
§
type Item = MergeAnalysis
The type of the elements being iterated over.
§
type IntoIter = Iter<MergeAnalysis>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for MergeAnalysis
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = MergeAnalysis
The resulting type after applying the ! operator.
source§
impl Octal for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for MergeAnalysis
source§
fn eq(&self, other: &MergeAnalysis) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for MergeAnalysis
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for MergeAnalysis
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = MergeAnalysis
The resulting type after applying the - operator.
source§
impl SubAssign for MergeAnalysis
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = MergeAnalysis
The resulting type after applying the - operator.
source§
impl SubAssign for MergeAnalysis
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for MergeAnalysis
source§
impl Eq for MergeAnalysis
source§
impl StructuralPartialEq for MergeAnalysis
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for MergeAnalysis
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for MergeAnalysis
source§
impl Eq for MergeAnalysis
source§
impl StructuralPartialEq for MergeAnalysis
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.MergePreference.html b/git2/struct.MergePreference.html
index 7c20ddfc1..60b928324 100644
--- a/git2/struct.MergePreference.html
+++ b/git2/struct.MergePreference.html
@@ -40,12 +40,12 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<MergePreference>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl MergePreference
source
pub fn is_none(&self) -> bool
source
pub fn is_no_fast_forward(&self) -> bool
source
pub fn is_fastforward_only(&self) -> bool
Trait Implementations§
source§
impl Binary for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for MergePreference
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
source§
impl MergePreference
source
pub fn is_none(&self) -> bool
source
pub fn is_no_fast_forward(&self) -> bool
source
pub fn is_fastforward_only(&self) -> bool
Trait Implementations§
source§
impl Binary for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for MergePreference
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

 
§
type Output = MergePreference
The resulting type after applying the & operator.
source§
impl BitAndAssign for MergePreference
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for MergePreference
source§
fn bitor(self, other: MergePreference) -> Self
The bitwise or (|) of the bits in two flags values.

 
§
type Output = MergePreference
The resulting type after applying the | operator.
source§
impl BitOrAssign for MergePreference
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for MergePreference
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = MergePreference
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for MergePreference
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
§
type Output = MergePreference
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for MergePreference
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

 
source§
impl Clone for MergePreference
source§
fn clone(&self) -> MergePreference
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<MergePreference> for MergePreference
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for MergePreference
source§
const FLAGS: &'static [Flag<MergePreference>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> MergePreference
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
@@ -55,7 +55,7 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<MergePreference> for MergePreference
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

 
source§
impl IntoIterator for MergePreference
§
type Item = MergePreference
The type of the elements being iterated over.
§
type IntoIter = Iter<MergePreference>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for MergePreference
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = MergePreference
The resulting type after applying the ! operator.
source§
impl Octal for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for MergePreference
source§
fn eq(&self, other: &MergePreference) -> bool
This method tests for self and other values to be equal, and is used
+
§
type Output = MergePreference
The resulting type after applying the ! operator.
source§
impl Octal for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for MergePreference
source§
fn eq(&self, other: &MergePreference) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for MergePreference
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for MergePreference
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
@@ -63,7 +63,7 @@ sufficient, and should not be overridden without very good reason.
§
type Output = MergePreference
The resulting type after applying the - operator.
source§
impl SubAssign for MergePreference
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for MergePreference
source§
impl Eq for MergePreference
source§
impl StructuralPartialEq for MergePreference
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for MergePreference
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for MergePreference
source§
impl Eq for MergePreference
source§
impl StructuralPartialEq for MergePreference
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.OdbLookupFlags.html b/git2/struct.OdbLookupFlags.html
index f30e41ba6..2be34f063 100644
--- a/git2/struct.OdbLookupFlags.html
+++ b/git2/struct.OdbLookupFlags.html
@@ -38,13 +38,13 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<OdbLookupFlags>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
Trait Implementations§
source§
impl Binary for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for OdbLookupFlags
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = OdbLookupFlags
The resulting type after applying the & operator.
source§
impl BitAndAssign for OdbLookupFlags
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
Trait Implementations§
source§
impl Binary for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for OdbLookupFlags
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = OdbLookupFlags
The resulting type after applying the & operator.
source§
impl BitAndAssign for OdbLookupFlags
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for OdbLookupFlags
source§
fn bitor(self, other: OdbLookupFlags) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = OdbLookupFlags
The resulting type after applying the | operator.
source§
impl BitOrAssign for OdbLookupFlags
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = OdbLookupFlags
The resulting type after applying the | operator.
source§
impl BitOrAssign for OdbLookupFlags
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for OdbLookupFlags
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = OdbLookupFlags
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for OdbLookupFlags
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for OdbLookupFlags
source§
fn clone(&self) -> OdbLookupFlags
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<OdbLookupFlags> for OdbLookupFlags
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
§
type Output = OdbLookupFlags
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for OdbLookupFlags
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
source§
impl Clone for OdbLookupFlags
source§
fn clone(&self) -> OdbLookupFlags
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<OdbLookupFlags> for OdbLookupFlags
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for OdbLookupFlags
source§
const FLAGS: &'static [Flag<OdbLookupFlags>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> OdbLookupFlags
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -52,8 +52,8 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<OdbLookupFlags> for OdbLookupFlags
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for OdbLookupFlags
§
type Item = OdbLookupFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<OdbLookupFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for OdbLookupFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = OdbLookupFlags
The resulting type after applying the ! operator.
source§
impl Octal for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for OdbLookupFlags
source§
fn eq(&self, other: &OdbLookupFlags) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for OdbLookupFlags
§
type Item = OdbLookupFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<OdbLookupFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for OdbLookupFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = OdbLookupFlags
The resulting type after applying the ! operator.
source§
impl Octal for OdbLookupFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for OdbLookupFlags
source§
fn eq(&self, other: &OdbLookupFlags) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for OdbLookupFlags
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for OdbLookupFlags
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
diff --git a/git2/struct.Oid.html b/git2/struct.Oid.html
index 115d562fd..62abf045b 100644
--- a/git2/struct.Oid.html
+++ b/git2/struct.Oid.html
@@ -18,7 +18,7 @@ and returns an Oid corresponding to the result. This does not store the object
 inside any object database or repository.

 
source
pub fn as_bytes(&self) -> &[u8] ⓘ
View this OID as a byte-slice 20 bytes in length.

 
source
pub fn is_zero(&self) -> bool
Test if this OID is all zeros.

-
Trait Implementations§
source§
impl AsRef<[u8]> for Oid
source§
fn as_ref(&self) -> &[u8] ⓘ
Converts this type into a shared reference of the (usually inferred) input type.
source§
impl Clone for Oid
source§
fn clone(&self) -> Oid
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Oid
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Oid
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Hex-encode this Oid into a formatter.

+
Trait Implementations§
source§
impl AsRef<[u8]> for Oid
source§
fn as_ref(&self) -> &[u8] ⓘ
Converts this type into a shared reference of the (usually inferred) input type.
source§
impl Clone for Oid
source§
fn clone(&self) -> Oid
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Oid
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Oid
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Hex-encode this Oid into a formatter.

 
source§
impl FromStr for Oid
source§
fn from_str(s: &str) -> Result<Oid, Error>
Parse a hex-formatted object id into an Oid structure.

 
§Errors

 
Returns an error if the string is empty, is longer than 40 hex
diff --git a/git2/struct.PathspecFlags.html b/git2/struct.PathspecFlags.html
index 41936c1bd..e6d16ccfd 100644
--- a/git2/struct.PathspecFlags.html
+++ b/git2/struct.PathspecFlags.html
@@ -50,8 +50,8 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<PathspecFlags>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl PathspecFlags
source
pub fn is_default(&self) -> bool
source
pub fn is_ignore_case(&self) -> bool
source
pub fn is_use_case(&self) -> bool
source
pub fn is_no_glob(&self) -> bool
source
pub fn is_no_match_error(&self) -> bool
source
pub fn is_find_failures(&self) -> bool
source
pub fn is_failures_only(&self) -> bool
Trait Implementations§
source§
impl Binary for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for PathspecFlags
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = PathspecFlags
The resulting type after applying the & operator.
source§
impl BitAndAssign for PathspecFlags
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
source§
impl PathspecFlags
source
pub fn is_default(&self) -> bool
source
pub fn is_ignore_case(&self) -> bool
source
pub fn is_use_case(&self) -> bool
source
pub fn is_no_glob(&self) -> bool
source
pub fn is_no_match_error(&self) -> bool
source
pub fn is_find_failures(&self) -> bool
source
pub fn is_failures_only(&self) -> bool
Trait Implementations§
source§
impl Binary for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for PathspecFlags
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = PathspecFlags
The resulting type after applying the & operator.
source§
impl BitAndAssign for PathspecFlags
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for PathspecFlags
source§
fn bitor(self, other: PathspecFlags) -> Self
The bitwise or (|) of the bits in two flags values.

 
§
type Output = PathspecFlags
The resulting type after applying the | operator.
source§
impl BitOrAssign for PathspecFlags
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for PathspecFlags
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

@@ -64,16 +64,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<PathspecFlags> for PathspecFlags
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for PathspecFlags
§
type Item = PathspecFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<PathspecFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for PathspecFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = PathspecFlags
The resulting type after applying the ! operator.
source§
impl Octal for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for PathspecFlags
source§
fn eq(&self, other: &PathspecFlags) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for PathspecFlags
§
type Item = PathspecFlags
The type of the elements being iterated over.
§
type IntoIter = Iter<PathspecFlags>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for PathspecFlags
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = PathspecFlags
The resulting type after applying the ! operator.
source§
impl Octal for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for PathspecFlags
source§
fn eq(&self, other: &PathspecFlags) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for PathspecFlags
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for PathspecFlags
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = PathspecFlags
The resulting type after applying the - operator.
source§
impl SubAssign for PathspecFlags
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = PathspecFlags
The resulting type after applying the - operator.
source§
impl SubAssign for PathspecFlags
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for PathspecFlags
source§
impl Eq for PathspecFlags
source§
impl StructuralPartialEq for PathspecFlags
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for PathspecFlags
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for PathspecFlags
source§
impl Eq for PathspecFlags
source§
impl StructuralPartialEq for PathspecFlags
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.ReferenceFormat.html b/git2/struct.ReferenceFormat.html
index f67fd3d08..3a6012dcb 100644
--- a/git2/struct.ReferenceFormat.html
+++ b/git2/struct.ReferenceFormat.html
@@ -46,13 +46,13 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<ReferenceFormat>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl ReferenceFormat
source
pub fn is_allow_onelevel(&self) -> bool
source
pub fn is_refspec_pattern(&self) -> bool
source
pub fn is_refspec_shorthand(&self) -> bool
Trait Implementations§
source§
impl Binary for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for ReferenceFormat
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = ReferenceFormat
The resulting type after applying the & operator.
source§
impl BitAndAssign for ReferenceFormat
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
source§
impl ReferenceFormat
source
pub fn is_allow_onelevel(&self) -> bool
source
pub fn is_refspec_pattern(&self) -> bool
source
pub fn is_refspec_shorthand(&self) -> bool
Trait Implementations§
source§
impl Binary for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for ReferenceFormat
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = ReferenceFormat
The resulting type after applying the & operator.
source§
impl BitAndAssign for ReferenceFormat
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for ReferenceFormat
source§
fn bitor(self, other: ReferenceFormat) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = ReferenceFormat
The resulting type after applying the | operator.
source§
impl BitOrAssign for ReferenceFormat
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = ReferenceFormat
The resulting type after applying the | operator.
source§
impl BitOrAssign for ReferenceFormat
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for ReferenceFormat
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = ReferenceFormat
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for ReferenceFormat
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for ReferenceFormat
source§
fn clone(&self) -> ReferenceFormat
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Default for ReferenceFormat
source§
fn default() -> Self
Returns the “default value” for a type. Read more
source§
impl Extend<ReferenceFormat> for ReferenceFormat
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
§
type Output = ReferenceFormat
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for ReferenceFormat
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
source§
impl Clone for ReferenceFormat
source§
fn clone(&self) -> ReferenceFormat
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Default for ReferenceFormat
source§
fn default() -> Self
Returns the “default value” for a type. Read more
source§
impl Extend<ReferenceFormat> for ReferenceFormat
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for ReferenceFormat
source§
const FLAGS: &'static [Flag<ReferenceFormat>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> ReferenceFormat
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -60,16 +60,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<ReferenceFormat> for ReferenceFormat
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for ReferenceFormat
§
type Item = ReferenceFormat
The type of the elements being iterated over.
§
type IntoIter = Iter<ReferenceFormat>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for ReferenceFormat
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = ReferenceFormat
The resulting type after applying the ! operator.
source§
impl Octal for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for ReferenceFormat
source§
fn eq(&self, other: &ReferenceFormat) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for ReferenceFormat
§
type Item = ReferenceFormat
The type of the elements being iterated over.
§
type IntoIter = Iter<ReferenceFormat>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for ReferenceFormat
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = ReferenceFormat
The resulting type after applying the ! operator.
source§
impl Octal for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for ReferenceFormat
source§
fn eq(&self, other: &ReferenceFormat) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for ReferenceFormat
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for ReferenceFormat
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = ReferenceFormat
The resulting type after applying the - operator.
source§
impl SubAssign for ReferenceFormat
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = ReferenceFormat
The resulting type after applying the - operator.
source§
impl SubAssign for ReferenceFormat
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
source§
impl UpperHex for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for ReferenceFormat
source§
impl Eq for ReferenceFormat
source§
impl StructuralPartialEq for ReferenceFormat
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
+
source§
impl UpperHex for ReferenceFormat
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for ReferenceFormat
source§
impl Eq for ReferenceFormat
source§
impl StructuralPartialEq for ReferenceFormat
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/git2/struct.RepositoryInitMode.html b/git2/struct.RepositoryInitMode.html
index 65c0f836b..a07498e20 100644
--- a/git2/struct.RepositoryInitMode.html
+++ b/git2/struct.RepositoryInitMode.html
@@ -38,13 +38,13 @@ will be yielded together as a final flags value.

 
source
pub const fn iter_names(&self) -> IterNames<RepositoryInitMode>
Yield a set of contained named flags values.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§
impl RepositoryInitMode
source
pub fn is_shared_umask(&self) -> bool
source
pub fn is_shared_group(&self) -> bool
source
pub fn is_shared_all(&self) -> bool
Trait Implementations§
source§
impl Binary for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for RepositoryInitMode
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

-
§
type Output = RepositoryInitMode
The resulting type after applying the & operator.
source§
impl BitAndAssign for RepositoryInitMode
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

+
source§
impl RepositoryInitMode
source
pub fn is_shared_umask(&self) -> bool
source
pub fn is_shared_group(&self) -> bool
source
pub fn is_shared_all(&self) -> bool
Trait Implementations§
source§
impl Binary for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl BitAnd for RepositoryInitMode
source§
fn bitand(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.

+
§
type Output = RepositoryInitMode
The resulting type after applying the & operator.
source§
impl BitAndAssign for RepositoryInitMode
source§
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in two flags values.

 
source§
impl BitOr for RepositoryInitMode
source§
fn bitor(self, other: RepositoryInitMode) -> Self
The bitwise or (|) of the bits in two flags values.

-
§
type Output = RepositoryInitMode
The resulting type after applying the | operator.
source§
impl BitOrAssign for RepositoryInitMode
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

+
§
type Output = RepositoryInitMode
The resulting type after applying the | operator.
source§
impl BitOrAssign for RepositoryInitMode
source§
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in two flags values.

 
source§
impl BitXor for RepositoryInitMode
source§
fn bitxor(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.

-
§
type Output = RepositoryInitMode
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for RepositoryInitMode
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

-
source§
impl Clone for RepositoryInitMode
source§
fn clone(&self) -> RepositoryInitMode
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<RepositoryInitMode> for RepositoryInitMode
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

+
§
type Output = RepositoryInitMode
The resulting type after applying the ^ operator.
source§
impl BitXorAssign for RepositoryInitMode
source§
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in two flags values.

+
source§
impl Clone for RepositoryInitMode
source§
fn clone(&self) -> RepositoryInitMode
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Extend<RepositoryInitMode> for RepositoryInitMode
source§
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.

 
source§
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§
fn extend_reserve(&mut self, additional: usize)
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§
impl Flags for RepositoryInitMode
source§
const FLAGS: &'static [Flag<RepositoryInitMode>] = _
The set of defined flags.
§
type Bits = u32
The underlying bits type.
source§
fn bits(&self) -> u32
Get the underlying bits value. Read more
source§
fn from_bits_retain(bits: u32) -> RepositoryInitMode
Convert from a bits value exactly.
source§
fn empty() -> Self
Get a flags value with all bits unset.
source§
fn all() -> Self
Get a flags value with all known bits set.
source§
fn from_bits(bits: Self::Bits) -> Option<Self>
Convert from a bits value. Read more
source§
fn from_bits_truncate(bits: Self::Bits) -> Self
Convert from a bits value, unsetting any unknown bits.
source§
fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set. Read more
source§
fn iter(&self) -> Iter<Self>
Yield a set of contained flags values. Read more
source§
fn iter_names(&self) -> IterNames<Self>
Yield a set of contained named flags values. Read more
source§
fn is_empty(&self) -> bool
Whether all bits in this flags value are unset.
source§
fn is_all(&self) -> bool
Whether all known bits in this flags value are set.
source§
fn intersects(&self, other: Self) -> bool
where
     Self: Sized,
Whether any set bits in a source flags value are also set in a target flags value.
source§
fn contains(&self, other: Self) -> bool
where
     Self: Sized,
Whether all set bits in a source flags value are also set in a target flags value.
source§
fn insert(&mut self, other: Self)
where
@@ -52,13 +52,13 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel
     Self: Sized,
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn toggle(&mut self, other: Self)
where
     Self: Sized,
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn set(&mut self, other: Self, value: bool)
where
     Self: Sized,
Call Flags::insert when value is true or Flags::remove when value is false.
source§
fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in two flags values.
source§
fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in two flags values.
source§
fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§
fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in two flags values.
source§
fn complement(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.
source§
impl FromIterator<RepositoryInitMode> for RepositoryInitMode
source§
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.

-
source§
impl IntoIterator for RepositoryInitMode
§
type Item = RepositoryInitMode
The type of the elements being iterated over.
§
type IntoIter = Iter<RepositoryInitMode>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for RepositoryInitMode
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§
type Output = RepositoryInitMode
The resulting type after applying the ! operator.
source§
impl Octal for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for RepositoryInitMode
source§
fn eq(&self, other: &RepositoryInitMode) -> bool
This method tests for self and other values to be equal, and is used
+
source§
impl IntoIterator for RepositoryInitMode
§
type Item = RepositoryInitMode
The type of the elements being iterated over.
§
type IntoIter = Iter<RepositoryInitMode>
Which kind of iterator are we turning this into?
source§
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
source§
impl LowerHex for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Not for RepositoryInitMode
source§
fn not(self) -> Self
The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§
type Output = RepositoryInitMode
The resulting type after applying the ! operator.
source§
impl Octal for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl PartialEq for RepositoryInitMode
source§
fn eq(&self, other: &RepositoryInitMode) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
 sufficient, and should not be overridden without very good reason.
source§
impl PublicFlags for RepositoryInitMode
§
type Primitive = u32
The type of the underlying storage.
§
type Internal = InternalBitFlags
The type of the internal field on the generated flags type.
source§
impl Sub for RepositoryInitMode
source§
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

-
§
type Output = RepositoryInitMode
The resulting type after applying the - operator.
source§
impl SubAssign for RepositoryInitMode
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

+
§
type Output = RepositoryInitMode
The resulting type after applying the - operator.
source§
impl SubAssign for RepositoryInitMode
source§
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!).

 
This method is not equivalent to self & !other when other has unknown bits set.
 difference won’t truncate other, but the ! operator will.

 
source§
impl UpperHex for RepositoryInitMode
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter.
source§
impl Copy for RepositoryInitMode
source§
impl Eq for RepositoryInitMode
source§
impl StructuralPartialEq for RepositoryInitMode
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for T
where
diff --git a/git2/struct.RepositoryOpenFlags.html b/git2/struct.RepositoryOpenFlags.html
index 0bc4e082d..ce090c050 100644
--- a/git2/struct.RepositoryOpenFlags.html
+++ b/git2/struct.RepositoryOpenFlags.html
@@ -40,12 +40,12 @@ will be yielded together as a final flags value.

 
This method is like iter, except only yields bits in contained named flags.
 Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
source§

impl RepositoryOpenFlags

source

pub fn is_cross_fs(&self) -> bool

source

pub fn is_bare(&self) -> bool

source

pub fn is_no_dotgit(&self) -> bool

source

pub fn is_from_env(&self) -> bool

Trait Implementations§

source§

impl Binary for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for RepositoryOpenFlags

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

-
§

type Output = RepositoryOpenFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for RepositoryOpenFlags

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

+
§

type Output = RepositoryOpenFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for RepositoryOpenFlags

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for RepositoryOpenFlags

source§

fn bitor(self, other: RepositoryOpenFlags) -> Self

The bitwise or (|) of the bits in two flags values.

-
§

type Output = RepositoryOpenFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign for RepositoryOpenFlags

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

+
§

type Output = RepositoryOpenFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign for RepositoryOpenFlags

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for RepositoryOpenFlags

source§

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

-
§

type Output = RepositoryOpenFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for RepositoryOpenFlags

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

-
source§

impl Clone for RepositoryOpenFlags

source§

fn clone(&self) -> RepositoryOpenFlags

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<RepositoryOpenFlags> for RepositoryOpenFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

+
§

type Output = RepositoryOpenFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for RepositoryOpenFlags

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

+
source§

impl Clone for RepositoryOpenFlags

source§

fn clone(&self) -> RepositoryOpenFlags

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<RepositoryOpenFlags> for RepositoryOpenFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for RepositoryOpenFlags

source§

const FLAGS: &'static [Flag<RepositoryOpenFlags>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> RepositoryOpenFlags

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where @@ -53,16 +53,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
source§

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.
source§

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.
source§

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<RepositoryOpenFlags> for RepositoryOpenFlags

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

-
source§

impl IntoIterator for RepositoryOpenFlags

§

type Item = RepositoryOpenFlags

The type of the elements being iterated over.
§

type IntoIter = Iter<RepositoryOpenFlags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for RepositoryOpenFlags

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§

type Output = RepositoryOpenFlags

The resulting type after applying the ! operator.
source§

impl Octal for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for RepositoryOpenFlags

source§

fn eq(&self, other: &RepositoryOpenFlags) -> bool

This method tests for self and other values to be equal, and is used +
source§

impl IntoIterator for RepositoryOpenFlags

§

type Item = RepositoryOpenFlags

The type of the elements being iterated over.
§

type IntoIter = Iter<RepositoryOpenFlags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for RepositoryOpenFlags

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§

type Output = RepositoryOpenFlags

The resulting type after applying the ! operator.
source§

impl Octal for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for RepositoryOpenFlags

source§

fn eq(&self, other: &RepositoryOpenFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for RepositoryOpenFlags

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Sub for RepositoryOpenFlags

source§

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
§

type Output = RepositoryOpenFlags

The resulting type after applying the - operator.
source§

impl SubAssign for RepositoryOpenFlags

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

+
§

type Output = RepositoryOpenFlags

The resulting type after applying the - operator.
source§

impl SubAssign for RepositoryOpenFlags

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
source§

impl UpperHex for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for RepositoryOpenFlags

source§

impl Eq for RepositoryOpenFlags

source§

impl StructuralPartialEq for RepositoryOpenFlags

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

source§

impl UpperHex for RepositoryOpenFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for RepositoryOpenFlags

source§

impl Eq for RepositoryOpenFlags

source§

impl StructuralPartialEq for RepositoryOpenFlags

Auto Trait Implementations§

§

impl Freeze for RepositoryOpenFlags

§

impl RefUnwindSafe for RepositoryOpenFlags

§

impl Send for RepositoryOpenFlags

§

impl Sync for RepositoryOpenFlags

§

impl Unpin for RepositoryOpenFlags

§

impl UnwindSafe for RepositoryOpenFlags

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/git2/struct.RevparseMode.html b/git2/struct.RevparseMode.html index 95fbf8e0d..dbfd2da6c 100644 --- a/git2/struct.RevparseMode.html +++ b/git2/struct.RevparseMode.html @@ -37,13 +37,13 @@ will be yielded together as a final flags value.

source

pub const fn iter_names(&self) -> IterNames<RevparseMode>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§

impl RevparseMode

source

pub fn is_no_single(&self) -> bool

source

pub fn is_range(&self) -> bool

source

pub fn is_merge_base(&self) -> bool

Trait Implementations§

source§

impl Binary for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for RevparseMode

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

-
§

type Output = RevparseMode

The resulting type after applying the & operator.
source§

impl BitAndAssign for RevparseMode

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

+
source§

impl RevparseMode

source

pub fn is_no_single(&self) -> bool

source

pub fn is_range(&self) -> bool

source

pub fn is_merge_base(&self) -> bool

Trait Implementations§

source§

impl Binary for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for RevparseMode

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

+
§

type Output = RevparseMode

The resulting type after applying the & operator.
source§

impl BitAndAssign for RevparseMode

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for RevparseMode

source§

fn bitor(self, other: RevparseMode) -> Self

The bitwise or (|) of the bits in two flags values.

-
§

type Output = RevparseMode

The resulting type after applying the | operator.
source§

impl BitOrAssign for RevparseMode

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

+
§

type Output = RevparseMode

The resulting type after applying the | operator.
source§

impl BitOrAssign for RevparseMode

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for RevparseMode

source§

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

-
§

type Output = RevparseMode

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for RevparseMode

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

-
source§

impl Clone for RevparseMode

source§

fn clone(&self) -> RevparseMode

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<RevparseMode> for RevparseMode

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

+
§

type Output = RevparseMode

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for RevparseMode

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

+
source§

impl Clone for RevparseMode

source§

fn clone(&self) -> RevparseMode

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<RevparseMode> for RevparseMode

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for RevparseMode

source§

const FLAGS: &'static [Flag<RevparseMode>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> RevparseMode

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where @@ -51,13 +51,13 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
source§

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.
source§

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.
source§

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<RevparseMode> for RevparseMode

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

-
source§

impl IntoIterator for RevparseMode

§

type Item = RevparseMode

The type of the elements being iterated over.
§

type IntoIter = Iter<RevparseMode>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for RevparseMode

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§

type Output = RevparseMode

The resulting type after applying the ! operator.
source§

impl Octal for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for RevparseMode

source§

fn eq(&self, other: &RevparseMode) -> bool

This method tests for self and other values to be equal, and is used +
source§

impl IntoIterator for RevparseMode

§

type Item = RevparseMode

The type of the elements being iterated over.
§

type IntoIter = Iter<RevparseMode>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for RevparseMode

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§

type Output = RevparseMode

The resulting type after applying the ! operator.
source§

impl Octal for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for RevparseMode

source§

fn eq(&self, other: &RevparseMode) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for RevparseMode

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Sub for RevparseMode

source§

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
§

type Output = RevparseMode

The resulting type after applying the - operator.
source§

impl SubAssign for RevparseMode

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

+
§

type Output = RevparseMode

The resulting type after applying the - operator.
source§

impl SubAssign for RevparseMode

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

source§

impl UpperHex for RevparseMode

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for RevparseMode

source§

impl Eq for RevparseMode

source§

impl StructuralPartialEq for RevparseMode

Auto Trait Implementations§

§

impl Freeze for RevparseMode

§

impl RefUnwindSafe for RevparseMode

§

impl Send for RevparseMode

§

impl Sync for RevparseMode

§

impl Unpin for RevparseMode

§

impl UnwindSafe for RevparseMode

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/git2/struct.Sort.html b/git2/struct.Sort.html index d32c89d26..cac5048ba 100644 --- a/git2/struct.Sort.html +++ b/git2/struct.Sort.html @@ -45,12 +45,12 @@ will be yielded together as a final flags value.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

source§

impl Sort

source

pub fn is_none(&self) -> bool

source

pub fn is_topological(&self) -> bool

source

pub fn is_time(&self) -> bool

source

pub fn is_reverse(&self) -> bool

Trait Implementations§

source§

impl Binary for Sort

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for Sort

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

-
§

type Output = Sort

The resulting type after applying the & operator.
source§

impl BitAndAssign for Sort

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

+
§

type Output = Sort

The resulting type after applying the & operator.
source§

impl BitAndAssign for Sort

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for Sort

source§

fn bitor(self, other: Sort) -> Self

The bitwise or (|) of the bits in two flags values.

-
§

type Output = Sort

The resulting type after applying the | operator.
source§

impl BitOrAssign for Sort

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

+
§

type Output = Sort

The resulting type after applying the | operator.
source§

impl BitOrAssign for Sort

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for Sort

source§

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

-
§

type Output = Sort

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for Sort

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

-
source§

impl Clone for Sort

source§

fn clone(&self) -> Sort

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Sort

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<Sort> for Sort

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

+
§

type Output = Sort

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for Sort

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

+
source§

impl Clone for Sort

source§

fn clone(&self) -> Sort

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Sort

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<Sort> for Sort

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for Sort

source§

const FLAGS: &'static [Flag<Sort>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> Sort

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where @@ -59,12 +59,12 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
source§

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.
source§

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.
source§

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<Sort> for Sort

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

source§

impl IntoIterator for Sort

§

type Item = Sort

The type of the elements being iterated over.
§

type IntoIter = Iter<Sort>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for Sort

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for Sort

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§

type Output = Sort

The resulting type after applying the ! operator.
source§

impl Octal for Sort

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for Sort

source§

fn eq(&self, other: &Sort) -> bool

This method tests for self and other values to be equal, and is used +
§

type Output = Sort

The resulting type after applying the ! operator.
source§

impl Octal for Sort

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for Sort

source§

fn eq(&self, other: &Sort) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for Sort

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Sub for Sort

source§

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
§

type Output = Sort

The resulting type after applying the - operator.
source§

impl SubAssign for Sort

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

+
§

type Output = Sort

The resulting type after applying the - operator.
source§

impl SubAssign for Sort

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

source§

impl UpperHex for Sort

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for Sort

source§

impl Eq for Sort

source§

impl StructuralPartialEq for Sort

Auto Trait Implementations§

§

impl Freeze for Sort

§

impl RefUnwindSafe for Sort

§

impl Send for Sort

§

impl Sync for Sort

§

impl Unpin for Sort

§

impl UnwindSafe for Sort

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/git2/struct.StashApplyFlags.html b/git2/struct.StashApplyFlags.html index a4823f3de..f95330080 100644 --- a/git2/struct.StashApplyFlags.html +++ b/git2/struct.StashApplyFlags.html @@ -35,13 +35,13 @@ will be yielded together as a final flags value.

source

pub const fn iter_names(&self) -> IterNames<StashApplyFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§

impl StashApplyFlags

source

pub fn is_default(&self) -> bool

source

pub fn is_reinstate_index(&self) -> bool

Trait Implementations§

source§

impl Binary for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for StashApplyFlags

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

-
§

type Output = StashApplyFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for StashApplyFlags

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

+
source§

impl StashApplyFlags

source

pub fn is_default(&self) -> bool

source

pub fn is_reinstate_index(&self) -> bool

Trait Implementations§

source§

impl Binary for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for StashApplyFlags

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

+
§

type Output = StashApplyFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for StashApplyFlags

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for StashApplyFlags

source§

fn bitor(self, other: StashApplyFlags) -> Self

The bitwise or (|) of the bits in two flags values.

-
§

type Output = StashApplyFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign for StashApplyFlags

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

+
§

type Output = StashApplyFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign for StashApplyFlags

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for StashApplyFlags

source§

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

§

type Output = StashApplyFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for StashApplyFlags

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

-
source§

impl Clone for StashApplyFlags

source§

fn clone(&self) -> StashApplyFlags

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for StashApplyFlags

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Extend<StashApplyFlags> for StashApplyFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

+
source§

impl Clone for StashApplyFlags

source§

fn clone(&self) -> StashApplyFlags

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for StashApplyFlags

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Extend<StashApplyFlags> for StashApplyFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for StashApplyFlags

source§

const FLAGS: &'static [Flag<StashApplyFlags>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> StashApplyFlags

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where @@ -49,16 +49,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
source§

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.
source§

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.
source§

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<StashApplyFlags> for StashApplyFlags

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

-
source§

impl IntoIterator for StashApplyFlags

§

type Item = StashApplyFlags

The type of the elements being iterated over.
§

type IntoIter = Iter<StashApplyFlags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for StashApplyFlags

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§

type Output = StashApplyFlags

The resulting type after applying the ! operator.
source§

impl Octal for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for StashApplyFlags

source§

fn eq(&self, other: &StashApplyFlags) -> bool

This method tests for self and other values to be equal, and is used +
source§

impl IntoIterator for StashApplyFlags

§

type Item = StashApplyFlags

The type of the elements being iterated over.
§

type IntoIter = Iter<StashApplyFlags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for StashApplyFlags

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§

type Output = StashApplyFlags

The resulting type after applying the ! operator.
source§

impl Octal for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for StashApplyFlags

source§

fn eq(&self, other: &StashApplyFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for StashApplyFlags

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Sub for StashApplyFlags

source§

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
§

type Output = StashApplyFlags

The resulting type after applying the - operator.
source§

impl SubAssign for StashApplyFlags

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

+
§

type Output = StashApplyFlags

The resulting type after applying the - operator.
source§

impl SubAssign for StashApplyFlags

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
source§

impl UpperHex for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for StashApplyFlags

source§

impl Eq for StashApplyFlags

source§

impl StructuralPartialEq for StashApplyFlags

Auto Trait Implementations§

§

impl Freeze for StashApplyFlags

§

impl RefUnwindSafe for StashApplyFlags

§

impl Send for StashApplyFlags

§

impl Sync for StashApplyFlags

§

impl Unpin for StashApplyFlags

§

impl UnwindSafe for StashApplyFlags

Blanket Implementations§

source§

impl<T> Any for T
where +

source§

impl UpperHex for StashApplyFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for StashApplyFlags

source§

impl Eq for StashApplyFlags

source§

impl StructuralPartialEq for StashApplyFlags

Auto Trait Implementations§

§

impl Freeze for StashApplyFlags

§

impl RefUnwindSafe for StashApplyFlags

§

impl Send for StashApplyFlags

§

impl Sync for StashApplyFlags

§

impl Unpin for StashApplyFlags

§

impl UnwindSafe for StashApplyFlags

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/git2/struct.StashFlags.html b/git2/struct.StashFlags.html index b6ca1740a..d77234afc 100644 --- a/git2/struct.StashFlags.html +++ b/git2/struct.StashFlags.html @@ -40,13 +40,13 @@ will be yielded together as a final flags value.

source

pub const fn iter_names(&self) -> IterNames<StashFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§

impl StashFlags

source

pub fn is_default(&self) -> bool

source

pub fn is_keep_index(&self) -> bool

source

pub fn is_include_untracked(&self) -> bool

source

pub fn is_include_ignored(&self) -> bool

Trait Implementations§

source§

impl Binary for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for StashFlags

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

-
§

type Output = StashFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for StashFlags

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

+
source§

impl StashFlags

source

pub fn is_default(&self) -> bool

source

pub fn is_keep_index(&self) -> bool

source

pub fn is_include_untracked(&self) -> bool

source

pub fn is_include_ignored(&self) -> bool

Trait Implementations§

source§

impl Binary for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for StashFlags

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

+
§

type Output = StashFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign for StashFlags

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for StashFlags

source§

fn bitor(self, other: StashFlags) -> Self

The bitwise or (|) of the bits in two flags values.

§

type Output = StashFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign for StashFlags

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for StashFlags

source§

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

-
§

type Output = StashFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for StashFlags

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

-
source§

impl Clone for StashFlags

source§

fn clone(&self) -> StashFlags

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for StashFlags

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Extend<StashFlags> for StashFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

+
§

type Output = StashFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for StashFlags

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

+
source§

impl Clone for StashFlags

source§

fn clone(&self) -> StashFlags

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for StashFlags

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Extend<StashFlags> for StashFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for StashFlags

source§

const FLAGS: &'static [Flag<StashFlags>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> StashFlags

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where @@ -54,13 +54,13 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
source§

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.
source§

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.
source§

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<StashFlags> for StashFlags

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

-
source§

impl IntoIterator for StashFlags

§

type Item = StashFlags

The type of the elements being iterated over.
§

type IntoIter = Iter<StashFlags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for StashFlags

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§

type Output = StashFlags

The resulting type after applying the ! operator.
source§

impl Octal for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for StashFlags

source§

fn eq(&self, other: &StashFlags) -> bool

This method tests for self and other values to be equal, and is used +
source§

impl IntoIterator for StashFlags

§

type Item = StashFlags

The type of the elements being iterated over.
§

type IntoIter = Iter<StashFlags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for StashFlags

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§

type Output = StashFlags

The resulting type after applying the ! operator.
source§

impl Octal for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for StashFlags

source§

fn eq(&self, other: &StashFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for StashFlags

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Sub for StashFlags

source§

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
§

type Output = StashFlags

The resulting type after applying the - operator.
source§

impl SubAssign for StashFlags

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

+
§

type Output = StashFlags

The resulting type after applying the - operator.
source§

impl SubAssign for StashFlags

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

source§

impl UpperHex for StashFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for StashFlags

source§

impl Eq for StashFlags

source§

impl StructuralPartialEq for StashFlags

Auto Trait Implementations§

§

impl Freeze for StashFlags

§

impl RefUnwindSafe for StashFlags

§

impl Send for StashFlags

§

impl Sync for StashFlags

§

impl Unpin for StashFlags

§

impl UnwindSafe for StashFlags

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/git2/struct.Status.html b/git2/struct.Status.html index 1584d868e..7f5f33f31 100644 --- a/git2/struct.Status.html +++ b/git2/struct.Status.html @@ -41,12 +41,12 @@ will be yielded together as a final flags value.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

source§

impl Status

source

pub fn is_index_new(&self) -> bool

source

pub fn is_index_modified(&self) -> bool

source

pub fn is_index_deleted(&self) -> bool

source

pub fn is_index_renamed(&self) -> bool

source

pub fn is_index_typechange(&self) -> bool

source

pub fn is_wt_new(&self) -> bool

source

pub fn is_wt_modified(&self) -> bool

source

pub fn is_wt_deleted(&self) -> bool

source

pub fn is_wt_typechange(&self) -> bool

source

pub fn is_wt_renamed(&self) -> bool

source

pub fn is_ignored(&self) -> bool

source

pub fn is_conflicted(&self) -> bool

Trait Implementations§

source§

impl Binary for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for Status

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

-
§

type Output = Status

The resulting type after applying the & operator.
source§

impl BitAndAssign for Status

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

+
§

type Output = Status

The resulting type after applying the & operator.
source§

impl BitAndAssign for Status

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for Status

source§

fn bitor(self, other: Status) -> Self

The bitwise or (|) of the bits in two flags values.

-
§

type Output = Status

The resulting type after applying the | operator.
source§

impl BitOrAssign for Status

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

+
§

type Output = Status

The resulting type after applying the | operator.
source§

impl BitOrAssign for Status

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for Status

source§

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

-
§

type Output = Status

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for Status

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

-
source§

impl Clone for Status

source§

fn clone(&self) -> Status

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<Status> for Status

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

+
§

type Output = Status

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for Status

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

+
source§

impl Clone for Status

source§

fn clone(&self) -> Status

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<Status> for Status

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for Status

source§

const FLAGS: &'static [Flag<Status>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> Status

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where @@ -54,16 +54,16 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
source§

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.
source§

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.
source§

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<Status> for Status

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

-
source§

impl IntoIterator for Status

§

type Item = Status

The type of the elements being iterated over.
§

type IntoIter = Iter<Status>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for Status

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§

type Output = Status

The resulting type after applying the ! operator.
source§

impl Octal for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for Status

source§

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used +
source§

impl IntoIterator for Status

§

type Item = Status

The type of the elements being iterated over.
§

type IntoIter = Iter<Status>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for Status

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

+
§

type Output = Status

The resulting type after applying the ! operator.
source§

impl Octal for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for Status

source§

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for Status

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Sub for Status

source§

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
§

type Output = Status

The resulting type after applying the - operator.
source§

impl SubAssign for Status

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

+
§

type Output = Status

The resulting type after applying the - operator.
source§

impl SubAssign for Status

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
source§

impl UpperHex for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for Status

source§

impl Eq for Status

source§

impl StructuralPartialEq for Status

Auto Trait Implementations§

§

impl Freeze for Status

§

impl RefUnwindSafe for Status

§

impl Send for Status

§

impl Sync for Status

§

impl Unpin for Status

§

impl UnwindSafe for Status

Blanket Implementations§

source§

impl<T> Any for T
where +

source§

impl UpperHex for Status

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for Status

source§

impl Eq for Status

source§

impl StructuralPartialEq for Status

Auto Trait Implementations§

§

impl Freeze for Status

§

impl RefUnwindSafe for Status

§

impl Send for Status

§

impl Sync for Status

§

impl Unpin for Status

§

impl UnwindSafe for Status

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/git2/struct.SubmoduleStatus.html b/git2/struct.SubmoduleStatus.html index 9911634f5..a50a6de75 100644 --- a/git2/struct.SubmoduleStatus.html +++ b/git2/struct.SubmoduleStatus.html @@ -71,13 +71,13 @@ will be yielded together as a final flags value.

source

pub const fn iter_names(&self) -> IterNames<SubmoduleStatus>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

-
source§

impl SubmoduleStatus

source

pub fn is_in_head(&self) -> bool

source

pub fn is_in_index(&self) -> bool

source

pub fn is_in_config(&self) -> bool

source

pub fn is_in_wd(&self) -> bool

source

pub fn is_index_added(&self) -> bool

source

pub fn is_index_deleted(&self) -> bool

source

pub fn is_index_modified(&self) -> bool

source

pub fn is_wd_uninitialized(&self) -> bool

source

pub fn is_wd_added(&self) -> bool

source

pub fn is_wd_deleted(&self) -> bool

source

pub fn is_wd_modified(&self) -> bool

source

pub fn is_wd_wd_modified(&self) -> bool

source

pub fn is_wd_untracked(&self) -> bool

Trait Implementations§

source§

impl Binary for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for SubmoduleStatus

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

-
§

type Output = SubmoduleStatus

The resulting type after applying the & operator.
source§

impl BitAndAssign for SubmoduleStatus

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

+
source§

impl SubmoduleStatus

source

pub fn is_in_head(&self) -> bool

source

pub fn is_in_index(&self) -> bool

source

pub fn is_in_config(&self) -> bool

source

pub fn is_in_wd(&self) -> bool

source

pub fn is_index_added(&self) -> bool

source

pub fn is_index_deleted(&self) -> bool

source

pub fn is_index_modified(&self) -> bool

source

pub fn is_wd_uninitialized(&self) -> bool

source

pub fn is_wd_added(&self) -> bool

source

pub fn is_wd_deleted(&self) -> bool

source

pub fn is_wd_modified(&self) -> bool

source

pub fn is_wd_wd_modified(&self) -> bool

source

pub fn is_wd_untracked(&self) -> bool

Trait Implementations§

source§

impl Binary for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd for SubmoduleStatus

source§

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

+
§

type Output = SubmoduleStatus

The resulting type after applying the & operator.
source§

impl BitAndAssign for SubmoduleStatus

source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for SubmoduleStatus

source§

fn bitor(self, other: SubmoduleStatus) -> Self

The bitwise or (|) of the bits in two flags values.

-
§

type Output = SubmoduleStatus

The resulting type after applying the | operator.
source§

impl BitOrAssign for SubmoduleStatus

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

+
§

type Output = SubmoduleStatus

The resulting type after applying the | operator.
source§

impl BitOrAssign for SubmoduleStatus

source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for SubmoduleStatus

source§

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

-
§

type Output = SubmoduleStatus

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for SubmoduleStatus

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

-
source§

impl Clone for SubmoduleStatus

source§

fn clone(&self) -> SubmoduleStatus

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<SubmoduleStatus> for SubmoduleStatus

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

+
§

type Output = SubmoduleStatus

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for SubmoduleStatus

source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

+
source§

impl Clone for SubmoduleStatus

source§

fn clone(&self) -> SubmoduleStatus

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<SubmoduleStatus> for SubmoduleStatus

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for SubmoduleStatus

source§

const FLAGS: &'static [Flag<SubmoduleStatus>] = _

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> SubmoduleStatus

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
source§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
source§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
source§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where @@ -86,15 +86,15 @@ Any unknown bits, or bits not corresponding to a contained flag will not be yiel Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.
source§

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.
source§

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.
source§

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<SubmoduleStatus> for SubmoduleStatus

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

source§

impl IntoIterator for SubmoduleStatus

§

type Item = SubmoduleStatus

The type of the elements being iterated over.
§

type IntoIter = Iter<SubmoduleStatus>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for SubmoduleStatus

source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

-
§

type Output = SubmoduleStatus

The resulting type after applying the ! operator.
source§

impl Octal for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for SubmoduleStatus

source§

fn eq(&self, other: &SubmoduleStatus) -> bool

This method tests for self and other values to be equal, and is used +
§

type Output = SubmoduleStatus

The resulting type after applying the ! operator.
source§

impl Octal for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl PartialEq for SubmoduleStatus

source§

fn eq(&self, other: &SubmoduleStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for SubmoduleStatus

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl Sub for SubmoduleStatus

source§

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
§

type Output = SubmoduleStatus

The resulting type after applying the - operator.
source§

impl SubAssign for SubmoduleStatus

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

+
§

type Output = SubmoduleStatus

The resulting type after applying the - operator.
source§

impl SubAssign for SubmoduleStatus

source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

-
source§

impl UpperHex for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for SubmoduleStatus

source§

impl Eq for SubmoduleStatus

source§

impl StructuralPartialEq for SubmoduleStatus

Auto Trait Implementations§

§

impl Freeze for SubmoduleStatus

§

impl RefUnwindSafe for SubmoduleStatus

§

impl Send for SubmoduleStatus

§

impl Sync for SubmoduleStatus

§

impl Unpin for SubmoduleStatus

§

impl UnwindSafe for SubmoduleStatus

Blanket Implementations§

source§

impl<T> Any for T
where +

source§

impl UpperHex for SubmoduleStatus

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for SubmoduleStatus

source§

impl Eq for SubmoduleStatus

source§

impl StructuralPartialEq for SubmoduleStatus

Auto Trait Implementations§

§

impl Freeze for SubmoduleStatus

§

impl RefUnwindSafe for SubmoduleStatus

§

impl Send for SubmoduleStatus

§

impl Sync for SubmoduleStatus

§

impl Unpin for SubmoduleStatus

§

impl UnwindSafe for SubmoduleStatus

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/context/struct.Context.html b/inkwell/context/struct.Context.html index b410ebef2..f773f9b71 100644 --- a/inkwell/context/struct.Context.html +++ b/inkwell/context/struct.Context.html @@ -518,12 +518,12 @@ ret_instr.set_metadata(md_string, 0);assert_eq!(string.print_to_string().to_string(), "[9 x i8] c\"my_string\"");

Trait Implementations§

source§

impl<'ctx> AsContextRef<'ctx> for &'ctx Context

source§

fn as_ctx_ref(&self) -> LLVMContextRef

Acquires the underlying raw pointer belonging to this Context type.

-
source§

impl Debug for Context

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Context

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl PartialEq<Context> for ContextRef<'_>

source§

fn eq(&self, other: &Context) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<ContextRef<'_>> for Context

source§

fn eq(&self, other: &ContextRef<'_>) -> bool

This method tests for self and other values to be equal, and is used +
source§

impl Debug for Context

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Context

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl PartialEq<Context> for ContextRef<'_>

source§

fn eq(&self, other: &Context) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Context

source§

fn eq(&self, other: &Context) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<ContextRef<'_>> for Context

source§

fn eq(&self, other: &ContextRef<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Context

source§

fn eq(&self, other: &Context) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Context

source§

impl Send for Context

source§

impl StructuralPartialEq for Context

Auto Trait Implementations§

§

impl Freeze for Context

§

impl RefUnwindSafe for Context

§

impl !Sync for Context

§

impl Unpin for Context

§

impl UnwindSafe for Context

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where diff --git a/inkwell/context/struct.ContextRef.html b/inkwell/context/struct.ContextRef.html index f4d16974c..6edc3673d 100644 --- a/inkwell/context/struct.ContextRef.html +++ b/inkwell/context/struct.ContextRef.html @@ -499,10 +499,10 @@ ret_instr.set_metadata(md_string, 0);

Trait Implementations§

source§

impl<'ctx> AsContextRef<'ctx> for ContextRef<'ctx>

source§

fn as_ctx_ref(&self) -> LLVMContextRef

Acquires the underlying raw pointer belonging to this ContextRef type.

source§

impl<'ctx> Clone for ContextRef<'ctx>

source§

fn clone(&self) -> ContextRef<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for ContextRef<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq<Context> for ContextRef<'_>

source§

fn eq(&self, other: &Context) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<ContextRef<'_>> for Context

source§

fn eq(&self, other: &ContextRef<'_>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for ContextRef<'ctx>

source§

fn eq(&self, other: &ContextRef<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<ContextRef<'_>> for Context

source§

fn eq(&self, other: &ContextRef<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for ContextRef<'ctx>

source§

fn eq(&self, other: &ContextRef<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> Copy for ContextRef<'ctx>

source§

impl<'ctx> Eq for ContextRef<'ctx>

source§

impl<'ctx> StructuralPartialEq for ContextRef<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for ContextRef<'ctx>

§

impl<'ctx> RefUnwindSafe for ContextRef<'ctx>

§

impl<'ctx> !Send for ContextRef<'ctx>

§

impl<'ctx> !Sync for ContextRef<'ctx>

§

impl<'ctx> Unpin for ContextRef<'ctx>

§

impl<'ctx> UnwindSafe for ContextRef<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where diff --git a/inkwell/support/enum.LoadLibraryError.html b/inkwell/support/enum.LoadLibraryError.html index 785ae3ddf..549b3ec76 100644 --- a/inkwell/support/enum.LoadLibraryError.html +++ b/inkwell/support/enum.LoadLibraryError.html @@ -5,7 +5,7 @@ }
Expand description

Possible errors that can occur when loading a library

Variants§

§

UnicodeError

The given path could not be converted to a &str

§

LoadingError

The given path could not be loaded as a library

-

Trait Implementations§

source§

impl Clone for LoadLibraryError

source§

fn clone(&self) -> LoadLibraryError

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for LoadLibraryError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for LoadLibraryError

source§

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for LoadLibraryError

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl PartialEq for LoadLibraryError

source§

fn eq(&self, other: &LoadLibraryError) -> bool

This method tests for self and other values to be equal, and is used +

Trait Implementations§

source§

impl Clone for LoadLibraryError

source§

fn clone(&self) -> LoadLibraryError

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for LoadLibraryError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for LoadLibraryError

source§

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for LoadLibraryError

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl PartialEq for LoadLibraryError

source§

fn eq(&self, other: &LoadLibraryError) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for LoadLibraryError

source§

impl Eq for LoadLibraryError

source§

impl StructuralPartialEq for LoadLibraryError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/inkwell/targets/struct.TargetTriple.html b/inkwell/targets/struct.TargetTriple.html index 38a233544..70543874b 100644 --- a/inkwell/targets/struct.TargetTriple.html +++ b/inkwell/targets/struct.TargetTriple.html @@ -1,5 +1,5 @@ TargetTriple in inkwell::targets - Rust
-

Struct inkwell::targets::TargetTriple

source · 
pub struct TargetTriple { /* private fields */ }

Implementations§

source§

impl TargetTriple

source

pub unsafe fn new(triple: LLVMString) -> TargetTriple

source

pub fn create(triple: &str) -> TargetTriple

source

pub fn as_str(&self) -> &CStr

source

pub fn as_ptr(&self) -> *const c_char

Trait Implementations§

source§

impl Debug for TargetTriple

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TargetTriple

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl PartialEq for TargetTriple

source§

fn eq(&self, other: &TargetTriple) -> bool

This method tests for self and other values to be equal, and is used +

Struct inkwell::targets::TargetTriple

source · 
pub struct TargetTriple { /* private fields */ }

Implementations§

source§

impl TargetTriple

source

pub unsafe fn new(triple: LLVMString) -> TargetTriple

source

pub fn create(triple: &str) -> TargetTriple

source

pub fn as_str(&self) -> &CStr

source

pub fn as_ptr(&self) -> *const c_char

Trait Implementations§

source§

impl Debug for TargetTriple

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TargetTriple

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl PartialEq for TargetTriple

source§

fn eq(&self, other: &TargetTriple) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for TargetTriple

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/inkwell/types/enum.AnyTypeEnum.html b/inkwell/types/enum.AnyTypeEnum.html index dce32024e..5449ad78a 100644 --- a/inkwell/types/enum.AnyTypeEnum.html +++ b/inkwell/types/enum.AnyTypeEnum.html @@ -21,9 +21,9 @@
§Safety

Undefined behavior, if referenced type isn’t part of AnyTypeEnum

source

pub fn into_array_type(self) -> ArrayType<'ctx>

source

pub fn into_float_type(self) -> FloatType<'ctx>

source

pub fn into_function_type(self) -> FunctionType<'ctx>

source

pub fn into_int_type(self) -> IntType<'ctx>

source

pub fn into_pointer_type(self) -> PointerType<'ctx>

source

pub fn into_struct_type(self) -> StructType<'ctx>

source

pub fn into_vector_type(self) -> VectorType<'ctx>

source

pub fn into_void_type(self) -> VoidType<'ctx>

source

pub fn is_array_type(self) -> bool

source

pub fn is_float_type(self) -> bool

source

pub fn is_function_type(self) -> bool

source

pub fn is_int_type(self) -> bool

source

pub fn is_pointer_type(self) -> bool

source

pub fn is_struct_type(self) -> bool

source

pub fn is_vector_type(self) -> bool

source

pub fn is_void_type(self) -> bool

source

pub fn size_of(&self) -> Option<IntValue<'ctx>>

source

pub fn print_to_string(self) -> LLVMString

Print the definition of a AnyTypeEnum to LLVMString.

-

Trait Implementations§

source§

impl<'ctx> AnyType<'ctx> for AnyTypeEnum<'ctx>

source§

fn as_any_type_enum(&self) -> AnyTypeEnum<'ctx>

Returns an AnyTypeEnum that represents the current type.
source§

fn print_to_string(&self) -> LLVMString

Prints the definition of a Type to a LLVMString.
source§

impl AsTypeRef for AnyTypeEnum<'_>

source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
source§

impl<'ctx> Clone for AnyTypeEnum<'ctx>

source§

fn clone(&self) -> AnyTypeEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for AnyTypeEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for AnyTypeEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FunctionType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: FunctionType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VoidType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: VoidType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for AnyTypeEnum<'ctx>

source§

fn eq(&self, other: &AnyTypeEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +

Trait Implementations§

source§

impl<'ctx> AnyType<'ctx> for AnyTypeEnum<'ctx>

source§

fn as_any_type_enum(&self) -> AnyTypeEnum<'ctx>

Returns an AnyTypeEnum that represents the current type.
source§

fn print_to_string(&self) -> LLVMString

Prints the definition of a Type to a LLVMString.
source§

impl AsTypeRef for AnyTypeEnum<'_>

source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
source§

impl<'ctx> Clone for AnyTypeEnum<'ctx>

source§

fn clone(&self) -> AnyTypeEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for AnyTypeEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for AnyTypeEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FunctionType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: FunctionType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VoidType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: VoidType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for AnyTypeEnum<'ctx>

source§

fn eq(&self, other: &AnyTypeEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for FunctionType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for VoidType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for AnyTypeEnum<'ctx>

source§

impl<'ctx> Eq for AnyTypeEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for AnyTypeEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for AnyTypeEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for AnyTypeEnum<'ctx>

§

impl<'ctx> !Send for AnyTypeEnum<'ctx>

§

impl<'ctx> !Sync for AnyTypeEnum<'ctx>

§

impl<'ctx> Unpin for AnyTypeEnum<'ctx>

§

impl<'ctx> UnwindSafe for AnyTypeEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for FunctionType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for VoidType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for AnyTypeEnum<'ctx>

source§

impl<'ctx> Eq for AnyTypeEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for AnyTypeEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for AnyTypeEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for AnyTypeEnum<'ctx>

§

impl<'ctx> !Send for AnyTypeEnum<'ctx>

§

impl<'ctx> !Sync for AnyTypeEnum<'ctx>

§

impl<'ctx> Unpin for AnyTypeEnum<'ctx>

§

impl<'ctx> UnwindSafe for AnyTypeEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/enum.BasicMetadataTypeEnum.html b/inkwell/types/enum.BasicMetadataTypeEnum.html index 389dd6640..13e2a25d2 100644 --- a/inkwell/types/enum.BasicMetadataTypeEnum.html +++ b/inkwell/types/enum.BasicMetadataTypeEnum.html @@ -8,9 +8,9 @@ VectorType(VectorType<'ctx>), MetadataType(MetadataType<'ctx>), }

Variants§

§

ArrayType(ArrayType<'ctx>)

§

FloatType(FloatType<'ctx>)

§

IntType(IntType<'ctx>)

§

PointerType(PointerType<'ctx>)

§

StructType(StructType<'ctx>)

§

VectorType(VectorType<'ctx>)

§

MetadataType(MetadataType<'ctx>)

Implementations§

source§

impl<'ctx> BasicMetadataTypeEnum<'ctx>

source

pub fn into_array_type(self) -> ArrayType<'ctx>

source

pub fn into_float_type(self) -> FloatType<'ctx>

source

pub fn into_int_type(self) -> IntType<'ctx>

source

pub fn into_pointer_type(self) -> PointerType<'ctx>

source

pub fn into_struct_type(self) -> StructType<'ctx>

source

pub fn into_vector_type(self) -> VectorType<'ctx>

source

pub fn into_metadata_type(self) -> MetadataType<'ctx>

source

pub fn is_array_type(self) -> bool

source

pub fn is_float_type(self) -> bool

source

pub fn is_int_type(self) -> bool

source

pub fn is_metadata_type(self) -> bool

source

pub fn is_pointer_type(self) -> bool

source

pub fn is_struct_type(self) -> bool

source

pub fn is_vector_type(self) -> bool

source

pub fn print_to_string(self) -> LLVMString

Print the definition of a BasicMetadataTypeEnum to LLVMString.

-

Trait Implementations§

source§

impl AsTypeRef for BasicMetadataTypeEnum<'_>

source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
source§

impl<'ctx> Clone for BasicMetadataTypeEnum<'ctx>

source§

fn clone(&self) -> BasicMetadataTypeEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicMetadataTypeEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicMetadataTypeEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: BasicTypeEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<MetadataType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: MetadataType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for BasicMetadataTypeEnum<'ctx>

source§

fn eq(&self, other: &BasicMetadataTypeEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +

Trait Implementations§

source§

impl AsTypeRef for BasicMetadataTypeEnum<'_>

source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
source§

impl<'ctx> Clone for BasicMetadataTypeEnum<'ctx>

source§

fn clone(&self) -> BasicMetadataTypeEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicMetadataTypeEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicMetadataTypeEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: BasicTypeEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<MetadataType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: MetadataType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for BasicMetadataTypeEnum<'ctx>

source§

fn eq(&self, other: &BasicMetadataTypeEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for MetadataType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicMetadataTypeEnum<'ctx>

source§

impl<'ctx> Eq for BasicMetadataTypeEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicMetadataTypeEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> !Send for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> !Sync for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> Unpin for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicMetadataTypeEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for MetadataType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicMetadataTypeEnum<'ctx>

source§

impl<'ctx> Eq for BasicMetadataTypeEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicMetadataTypeEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> !Send for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> !Sync for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> Unpin for BasicMetadataTypeEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicMetadataTypeEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/enum.BasicTypeEnum.html b/inkwell/types/enum.BasicTypeEnum.html index ce07d678e..1e376a1c2 100644 --- a/inkwell/types/enum.BasicTypeEnum.html +++ b/inkwell/types/enum.BasicTypeEnum.html @@ -30,9 +30,9 @@ param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>

Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. -For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for BasicTypeEnum<'ctx>

source§

fn clone(&self) -> BasicTypeEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicTypeEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicTypeEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: BasicTypeEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for BasicTypeEnum<'ctx>

source§

fn eq(&self, other: &BasicTypeEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for BasicTypeEnum<'ctx>

source§

fn clone(&self) -> BasicTypeEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicTypeEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicTypeEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: BasicTypeEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for BasicTypeEnum<'ctx>

source§

fn eq(&self, other: &BasicTypeEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicTypeEnum<'ctx>

source§

impl<'ctx> Eq for BasicTypeEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicTypeEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicTypeEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicTypeEnum<'ctx>

§

impl<'ctx> !Send for BasicTypeEnum<'ctx>

§

impl<'ctx> !Sync for BasicTypeEnum<'ctx>

§

impl<'ctx> Unpin for BasicTypeEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicTypeEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicTypeEnum<'ctx>

source§

impl<'ctx> Eq for BasicTypeEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicTypeEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicTypeEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicTypeEnum<'ctx>

§

impl<'ctx> !Send for BasicTypeEnum<'ctx>

§

impl<'ctx> !Sync for BasicTypeEnum<'ctx>

§

impl<'ctx> Unpin for BasicTypeEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicTypeEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/struct.ArrayType.html b/inkwell/types/struct.ArrayType.html index b526a87d5..e9267b558 100644 --- a/inkwell/types/struct.ArrayType.html +++ b/inkwell/types/struct.ArrayType.html @@ -141,7 +141,7 @@ ) -> FunctionType<'ctx>
Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for ArrayType<'ctx>

source§

fn clone(&self) -> ArrayType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for ArrayType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for ArrayType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: ArrayType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for ArrayType<'ctx>

source§

fn eq(&self, other: &ArrayType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for ArrayType<'ctx>

source§

impl<'ctx> Eq for ArrayType<'ctx>

source§

impl<'ctx> StructuralPartialEq for ArrayType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for ArrayType<'ctx>

§

impl<'ctx> RefUnwindSafe for ArrayType<'ctx>

§

impl<'ctx> !Send for ArrayType<'ctx>

§

impl<'ctx> !Sync for ArrayType<'ctx>

§

impl<'ctx> Unpin for ArrayType<'ctx>

§

impl<'ctx> UnwindSafe for ArrayType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for ArrayType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for ArrayType<'ctx>

source§

impl<'ctx> Eq for ArrayType<'ctx>

source§

impl<'ctx> StructuralPartialEq for ArrayType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for ArrayType<'ctx>

§

impl<'ctx> RefUnwindSafe for ArrayType<'ctx>

§

impl<'ctx> !Send for ArrayType<'ctx>

§

impl<'ctx> !Sync for ArrayType<'ctx>

§

impl<'ctx> Unpin for ArrayType<'ctx>

§

impl<'ctx> UnwindSafe for ArrayType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/struct.FloatType.html b/inkwell/types/struct.FloatType.html index 8d6f7db3e..b1418f6f9 100644 --- a/inkwell/types/struct.FloatType.html +++ b/inkwell/types/struct.FloatType.html @@ -162,9 +162,9 @@ so this may produce unexpected results and should not be relied upon for validat param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>
Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. -For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for FloatType<'ctx>

source§

fn clone(&self) -> FloatType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for FloatType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FloatType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathType<'ctx> for FloatType<'ctx>

§

type ValueType = FloatValue<'ctx>

The value instance of a float or float vector type.
§

type MathConvType = IntType<'ctx>

The type for float to int or float vector to int vector conversions.
source§

impl<'ctx> From<FloatType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for FloatType<'ctx>

source§

fn eq(&self, other: &FloatType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for FloatType<'ctx>

source§

fn clone(&self) -> FloatType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for FloatType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FloatType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathType<'ctx> for FloatType<'ctx>

§

type ValueType = FloatValue<'ctx>

The value instance of a float or float vector type.
§

type MathConvType = IntType<'ctx>

The type for float to int or float vector to int vector conversions.
source§

impl<'ctx> From<FloatType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: FloatType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for FloatType<'ctx>

source§

fn eq(&self, other: &FloatType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for FloatType<'ctx>

source§

impl<'ctx> Eq for FloatType<'ctx>

source§

impl<'ctx> StructuralPartialEq for FloatType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for FloatType<'ctx>

§

impl<'ctx> RefUnwindSafe for FloatType<'ctx>

§

impl<'ctx> !Send for FloatType<'ctx>

§

impl<'ctx> !Sync for FloatType<'ctx>

§

impl<'ctx> Unpin for FloatType<'ctx>

§

impl<'ctx> UnwindSafe for FloatType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for FloatType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for FloatType<'ctx>

source§

impl<'ctx> Eq for FloatType<'ctx>

source§

impl<'ctx> StructuralPartialEq for FloatType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for FloatType<'ctx>

§

impl<'ctx> RefUnwindSafe for FloatType<'ctx>

§

impl<'ctx> !Send for FloatType<'ctx>

§

impl<'ctx> !Sync for FloatType<'ctx>

§

impl<'ctx> Unpin for FloatType<'ctx>

§

impl<'ctx> UnwindSafe for FloatType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/struct.IntType.html b/inkwell/types/struct.IntType.html index 1b3e1f4fa..3ca6c1873 100644 --- a/inkwell/types/struct.IntType.html +++ b/inkwell/types/struct.IntType.html @@ -191,9 +191,9 @@ so this may produce unexpected results and should not be relied upon for validat param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>
Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. -For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for IntType<'ctx>

source§

fn clone(&self) -> IntType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for IntType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for IntType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<IntType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> IntMathType<'ctx> for IntType<'ctx>

§

type ValueType = IntValue<'ctx>

The value instance of an int or int vector type.
§

type MathConvType = FloatType<'ctx>

The type for int to float or int vector to float vector conversions.
§

type PtrConvType = PointerType<'ctx>

The type for int to pointer or int vector to pointer vector conversions.
source§

impl<'ctx> PartialEq for IntType<'ctx>

source§

fn eq(&self, other: &IntType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for IntType<'ctx>

source§

fn clone(&self) -> IntType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for IntType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for IntType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<IntType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: IntType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> IntMathType<'ctx> for IntType<'ctx>

§

type ValueType = IntValue<'ctx>

The value instance of an int or int vector type.
§

type MathConvType = FloatType<'ctx>

The type for int to float or int vector to float vector conversions.
§

type PtrConvType = PointerType<'ctx>

The type for int to pointer or int vector to pointer vector conversions.
source§

impl<'ctx> PartialEq for IntType<'ctx>

source§

fn eq(&self, other: &IntType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for IntType<'ctx>

source§

impl<'ctx> Eq for IntType<'ctx>

source§

impl<'ctx> StructuralPartialEq for IntType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for IntType<'ctx>

§

impl<'ctx> RefUnwindSafe for IntType<'ctx>

§

impl<'ctx> !Send for IntType<'ctx>

§

impl<'ctx> !Sync for IntType<'ctx>

§

impl<'ctx> Unpin for IntType<'ctx>

§

impl<'ctx> UnwindSafe for IntType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for IntType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for IntType<'ctx>

source§

impl<'ctx> Eq for IntType<'ctx>

source§

impl<'ctx> StructuralPartialEq for IntType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for IntType<'ctx>

§

impl<'ctx> RefUnwindSafe for IntType<'ctx>

§

impl<'ctx> !Send for IntType<'ctx>

§

impl<'ctx> !Sync for IntType<'ctx>

§

impl<'ctx> Unpin for IntType<'ctx>

§

impl<'ctx> UnwindSafe for IntType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/struct.MetadataType.html b/inkwell/types/struct.MetadataType.html index c6577ddb4..58e6813f1 100644 --- a/inkwell/types/struct.MetadataType.html +++ b/inkwell/types/struct.MetadataType.html @@ -23,7 +23,7 @@ assert_eq!(md_type.get_context(), context);
source

pub fn print_to_string(self) -> LLVMString

Print the definition of a MetadataType to LLVMString.

-

Trait Implementations§

source§

impl AsTypeRef for MetadataType<'_>

source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
source§

impl<'ctx> Clone for MetadataType<'ctx>

source§

fn clone(&self) -> MetadataType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for MetadataType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for MetadataType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<MetadataType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: MetadataType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for MetadataType<'ctx>

source§

fn eq(&self, other: &MetadataType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +

Trait Implementations§

source§

impl AsTypeRef for MetadataType<'_>

source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
source§

impl<'ctx> Clone for MetadataType<'ctx>

source§

fn clone(&self) -> MetadataType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for MetadataType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for MetadataType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<MetadataType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: MetadataType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for MetadataType<'ctx>

source§

fn eq(&self, other: &MetadataType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for MetadataType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for MetadataType<'ctx>

source§

impl<'ctx> Eq for MetadataType<'ctx>

source§

impl<'ctx> StructuralPartialEq for MetadataType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for MetadataType<'ctx>

§

impl<'ctx> RefUnwindSafe for MetadataType<'ctx>

§

impl<'ctx> !Send for MetadataType<'ctx>

§

impl<'ctx> !Sync for MetadataType<'ctx>

§

impl<'ctx> Unpin for MetadataType<'ctx>

§

impl<'ctx> UnwindSafe for MetadataType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/inkwell/types/struct.PointerType.html b/inkwell/types/struct.PointerType.html index 065944e65..cfcbea86e 100644 --- a/inkwell/types/struct.PointerType.html +++ b/inkwell/types/struct.PointerType.html @@ -207,9 +207,9 @@ so this function may be removed in the future.

param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>

Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. -For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for PointerType<'ctx>

source§

fn clone(&self) -> PointerType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for PointerType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for PointerType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<PointerType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for PointerType<'ctx>

source§

fn eq(&self, other: &PointerType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for PointerType<'ctx>

source§

fn clone(&self) -> PointerType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for PointerType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for PointerType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<PointerType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: PointerType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for PointerType<'ctx>

source§

fn eq(&self, other: &PointerType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PointerMathType<'ctx> for PointerType<'ctx>

§

type ValueType = PointerValue<'ctx>

The value instance of a pointer type.
§

type PtrConvType = IntType<'ctx>

The type for pointer to int or pointer vector to int conversions.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for PointerType<'ctx>

source§

impl<'ctx> Eq for PointerType<'ctx>

source§

impl<'ctx> StructuralPartialEq for PointerType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for PointerType<'ctx>

§

impl<'ctx> RefUnwindSafe for PointerType<'ctx>

§

impl<'ctx> !Send for PointerType<'ctx>

§

impl<'ctx> !Sync for PointerType<'ctx>

§

impl<'ctx> Unpin for PointerType<'ctx>

§

impl<'ctx> UnwindSafe for PointerType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PointerMathType<'ctx> for PointerType<'ctx>

§

type ValueType = PointerValue<'ctx>

The value instance of a pointer type.
§

type PtrConvType = IntType<'ctx>

The type for pointer to int or pointer vector to int conversions.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for PointerType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for PointerType<'ctx>

source§

impl<'ctx> Eq for PointerType<'ctx>

source§

impl<'ctx> StructuralPartialEq for PointerType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for PointerType<'ctx>

§

impl<'ctx> RefUnwindSafe for PointerType<'ctx>

§

impl<'ctx> !Send for PointerType<'ctx>

§

impl<'ctx> !Sync for PointerType<'ctx>

§

impl<'ctx> Unpin for PointerType<'ctx>

§

impl<'ctx> UnwindSafe for PointerType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/struct.StructType.html b/inkwell/types/struct.StructType.html index df509f5e8..f084c10de 100644 --- a/inkwell/types/struct.StructType.html +++ b/inkwell/types/struct.StructType.html @@ -211,9 +211,9 @@ opaque_struct_type.set_body(&[f32_type.into()], BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>
Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. -For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for StructType<'ctx>

source§

fn clone(&self) -> StructType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for StructType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for StructType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<StructType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for StructType<'ctx>

source§

fn eq(&self, other: &StructType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for StructType<'ctx>

source§

fn clone(&self) -> StructType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for StructType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for StructType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<StructType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: StructType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> PartialEq for StructType<'ctx>

source§

fn eq(&self, other: &StructType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for StructType<'ctx>

source§

impl<'ctx> Eq for StructType<'ctx>

source§

impl<'ctx> StructuralPartialEq for StructType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for StructType<'ctx>

§

impl<'ctx> RefUnwindSafe for StructType<'ctx>

§

impl<'ctx> !Send for StructType<'ctx>

§

impl<'ctx> !Sync for StructType<'ctx>

§

impl<'ctx> Unpin for StructType<'ctx>

§

impl<'ctx> UnwindSafe for StructType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for StructType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for StructType<'ctx>

source§

impl<'ctx> Eq for StructType<'ctx>

source§

impl<'ctx> StructuralPartialEq for StructType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for StructType<'ctx>

§

impl<'ctx> RefUnwindSafe for StructType<'ctx>

§

impl<'ctx> !Send for StructType<'ctx>

§

impl<'ctx> !Sync for StructType<'ctx>

§

impl<'ctx> Unpin for StructType<'ctx>

§

impl<'ctx> UnwindSafe for StructType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/types/struct.VectorType.html b/inkwell/types/struct.VectorType.html index 1b73847d3..9b0a728cb 100644 --- a/inkwell/types/struct.VectorType.html +++ b/inkwell/types/struct.VectorType.html @@ -157,9 +157,9 @@ param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>
Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. -For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for VectorType<'ctx>

source§

fn clone(&self) -> VectorType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for VectorType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for VectorType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathType<'ctx> for VectorType<'ctx>

§

type ValueType = VectorValue<'ctx>

The value instance of a float or float vector type.
§

type MathConvType = VectorType<'ctx>

The type for float to int or float vector to int vector conversions.
source§

impl<'ctx> From<VectorType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> IntMathType<'ctx> for VectorType<'ctx>

§

type ValueType = VectorValue<'ctx>

The value instance of an int or int vector type.
§

type MathConvType = VectorType<'ctx>

The type for int to float or int vector to float vector conversions.
§

type PtrConvType = VectorType<'ctx>

The type for int to pointer or int vector to pointer vector conversions.
source§

impl<'ctx> PartialEq for VectorType<'ctx>

source§

fn eq(&self, other: &VectorType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +For example, opaque structs are unsized. Read more
source§

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements. Read more
source§

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
Create a PointerType that points to this BasicType. Read more
source§

impl<'ctx> Clone for VectorType<'ctx>

source§

fn clone(&self) -> VectorType<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for VectorType<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for VectorType<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathType<'ctx> for VectorType<'ctx>

§

type ValueType = VectorValue<'ctx>

The value instance of a float or float vector type.
§

type MathConvType = VectorType<'ctx>

The type for float to int or float vector to int vector conversions.
source§

impl<'ctx> From<VectorType<'ctx>> for AnyTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicMetadataTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorType<'ctx>> for BasicTypeEnum<'ctx>

source§

fn from(value: VectorType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> IntMathType<'ctx> for VectorType<'ctx>

§

type ValueType = VectorValue<'ctx>

The value instance of an int or int vector type.
§

type MathConvType = VectorType<'ctx>

The type for int to float or int vector to float vector conversions.
§

type PtrConvType = VectorType<'ctx>

The type for int to pointer or int vector to pointer vector conversions.
source§

impl<'ctx> PartialEq for VectorType<'ctx>

source§

fn eq(&self, other: &VectorType<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PointerMathType<'ctx> for VectorType<'ctx>

§

type ValueType = VectorValue<'ctx>

The value instance of a pointer type.
§

type PtrConvType = VectorType<'ctx>

The type for pointer to int or pointer vector to int conversions.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for VectorType<'ctx>

source§

impl<'ctx> Eq for VectorType<'ctx>

source§

impl<'ctx> StructuralPartialEq for VectorType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for VectorType<'ctx>

§

impl<'ctx> RefUnwindSafe for VectorType<'ctx>

§

impl<'ctx> !Send for VectorType<'ctx>

§

impl<'ctx> !Sync for VectorType<'ctx>

§

impl<'ctx> Unpin for VectorType<'ctx>

§

impl<'ctx> UnwindSafe for VectorType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PointerMathType<'ctx> for VectorType<'ctx>

§

type ValueType = VectorValue<'ctx>

The value instance of a pointer type.
§

type PtrConvType = VectorType<'ctx>

The type for pointer to int or pointer vector to int conversions.
source§

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for VectorType<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for VectorType<'ctx>

source§

impl<'ctx> Eq for VectorType<'ctx>

source§

impl<'ctx> StructuralPartialEq for VectorType<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for VectorType<'ctx>

§

impl<'ctx> RefUnwindSafe for VectorType<'ctx>

§

impl<'ctx> !Send for VectorType<'ctx>

§

impl<'ctx> !Sync for VectorType<'ctx>

§

impl<'ctx> Unpin for VectorType<'ctx>

§

impl<'ctx> UnwindSafe for VectorType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/enum.AggregateValueEnum.html b/inkwell/values/enum.AggregateValueEnum.html index 27eccda1a..e3b7552f0 100644 --- a/inkwell/values/enum.AggregateValueEnum.html +++ b/inkwell/values/enum.AggregateValueEnum.html @@ -6,19 +6,19 @@
§Safety

The ref must be valid and of supported aggregate type enum options (LLVMTypeKind).

source

pub fn is_array_value(self) -> bool

source

pub fn is_struct_value(self) -> bool

source

pub fn into_array_value(self) -> ArrayValue<'ctx>

source

pub fn into_struct_value(self) -> StructValue<'ctx>

Trait Implementations§

source§

impl<'ctx> AggregateValue<'ctx> for AggregateValueEnum<'ctx>

source§

fn as_aggregate_value_enum(&self) -> AggregateValueEnum<'ctx>

Returns an enum containing a typed version of the AggregateValue.
source§

impl<'ctx> AnyValue<'ctx> for AggregateValueEnum<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for AggregateValueEnum<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for AggregateValueEnum<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for AggregateValueEnum<'ctx>

source§

fn clone(&self) -> AggregateValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for AggregateValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for AggregateValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for AggregateValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for AggregateValueEnum<'ctx>

source§

fn clone(&self) -> AggregateValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for AggregateValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for AggregateValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for AggregateValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for AggregateValueEnum<'ctx>

source§

impl<'ctx> Eq for AggregateValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for AggregateValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for AggregateValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for AggregateValueEnum<'ctx>

§

impl<'ctx> !Send for AggregateValueEnum<'ctx>

§

impl<'ctx> !Sync for AggregateValueEnum<'ctx>

§

impl<'ctx> Unpin for AggregateValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for AggregateValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for AggregateValueEnum<'ctx>

source§

impl<'ctx> Eq for AggregateValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for AggregateValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for AggregateValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for AggregateValueEnum<'ctx>

§

impl<'ctx> !Send for AggregateValueEnum<'ctx>

§

impl<'ctx> !Sync for AggregateValueEnum<'ctx>

§

impl<'ctx> Unpin for AggregateValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for AggregateValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/enum.AnyValueEnum.html b/inkwell/values/enum.AnyValueEnum.html index 835761019..e6fdcfd72 100644 --- a/inkwell/values/enum.AnyValueEnum.html +++ b/inkwell/values/enum.AnyValueEnum.html @@ -13,51 +13,51 @@ }

Variants§

§

ArrayValue(ArrayValue<'ctx>)

§

IntValue(IntValue<'ctx>)

§

FloatValue(FloatValue<'ctx>)

§

PhiValue(PhiValue<'ctx>)

§

FunctionValue(FunctionValue<'ctx>)

§

PointerValue(PointerValue<'ctx>)

§

StructValue(StructValue<'ctx>)

§

VectorValue(VectorValue<'ctx>)

§

InstructionValue(InstructionValue<'ctx>)

§

MetadataValue(MetadataValue<'ctx>)

Implementations§

source§

impl<'ctx> AnyValueEnum<'ctx>

source

pub unsafe fn new(value: LLVMValueRef) -> Self

Get a value from an LLVMValueRef.

§Safety

The ref must be valid and of supported enum type options (LLVMTypeKind).

-
source

pub fn get_type(&self) -> AnyTypeEnum<'ctx>

source

pub fn is_array_value(self) -> bool

source

pub fn is_int_value(self) -> bool

source

pub fn is_float_value(self) -> bool

source

pub fn is_phi_value(self) -> bool

source

pub fn is_function_value(self) -> bool

source

pub fn is_pointer_value(self) -> bool

source

pub fn is_struct_value(self) -> bool

source

pub fn is_vector_value(self) -> bool

source

pub fn is_instruction_value(self) -> bool

source

pub fn into_array_value(self) -> ArrayValue<'ctx>

source

pub fn into_int_value(self) -> IntValue<'ctx>

source

pub fn into_float_value(self) -> FloatValue<'ctx>

source

pub fn into_phi_value(self) -> PhiValue<'ctx>

source

pub fn into_function_value(self) -> FunctionValue<'ctx>

source

pub fn into_pointer_value(self) -> PointerValue<'ctx>

source

pub fn into_struct_value(self) -> StructValue<'ctx>

source

pub fn into_vector_value(self) -> VectorValue<'ctx>

source

pub fn into_instruction_value(self) -> InstructionValue<'ctx>

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for AnyValueEnum<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for AnyValueEnum<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for AnyValueEnum<'ctx>

source§

fn clone(&self) -> AnyValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for AnyValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for AnyValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FunctionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: InstructionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<MetadataValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: MetadataValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PhiValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PhiValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for AnyValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +

source

pub fn get_type(&self) -> AnyTypeEnum<'ctx>

source

pub fn is_array_value(self) -> bool

source

pub fn is_int_value(self) -> bool

source

pub fn is_float_value(self) -> bool

source

pub fn is_phi_value(self) -> bool

source

pub fn is_function_value(self) -> bool

source

pub fn is_pointer_value(self) -> bool

source

pub fn is_struct_value(self) -> bool

source

pub fn is_vector_value(self) -> bool

source

pub fn is_instruction_value(self) -> bool

source

pub fn into_array_value(self) -> ArrayValue<'ctx>

source

pub fn into_int_value(self) -> IntValue<'ctx>

source

pub fn into_float_value(self) -> FloatValue<'ctx>

source

pub fn into_phi_value(self) -> PhiValue<'ctx>

source

pub fn into_function_value(self) -> FunctionValue<'ctx>

source

pub fn into_pointer_value(self) -> PointerValue<'ctx>

source

pub fn into_struct_value(self) -> StructValue<'ctx>

source

pub fn into_vector_value(self) -> VectorValue<'ctx>

source

pub fn into_instruction_value(self) -> InstructionValue<'ctx>

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for AnyValueEnum<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for AnyValueEnum<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for AnyValueEnum<'ctx>

source§

fn clone(&self) -> AnyValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for AnyValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for AnyValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FunctionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: InstructionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<MetadataValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: MetadataValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PhiValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PhiValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for AnyValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for MetadataValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PhiValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PhiValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<MetadataValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PhiValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PhiValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<MetadataValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PhiValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PhiValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for AnyValueEnum<'ctx>

source§

impl<'ctx> Eq for AnyValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for AnyValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for AnyValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for AnyValueEnum<'ctx>

§

impl<'ctx> !Send for AnyValueEnum<'ctx>

§

impl<'ctx> !Sync for AnyValueEnum<'ctx>

§

impl<'ctx> Unpin for AnyValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for AnyValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for AnyValueEnum<'ctx>

source§

impl<'ctx> Eq for AnyValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for AnyValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for AnyValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for AnyValueEnum<'ctx>

§

impl<'ctx> !Send for AnyValueEnum<'ctx>

§

impl<'ctx> !Sync for AnyValueEnum<'ctx>

§

impl<'ctx> Unpin for AnyValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for AnyValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/enum.BasicMetadataValueEnum.html b/inkwell/values/enum.BasicMetadataValueEnum.html index 219a45a65..cc5d557a2 100644 --- a/inkwell/values/enum.BasicMetadataValueEnum.html +++ b/inkwell/values/enum.BasicMetadataValueEnum.html @@ -7,39 +7,39 @@ StructValue(StructValue<'ctx>), VectorValue(VectorValue<'ctx>), MetadataValue(MetadataValue<'ctx>), -}

Variants§

§

ArrayValue(ArrayValue<'ctx>)

§

IntValue(IntValue<'ctx>)

§

FloatValue(FloatValue<'ctx>)

§

PointerValue(PointerValue<'ctx>)

§

StructValue(StructValue<'ctx>)

§

VectorValue(VectorValue<'ctx>)

§

MetadataValue(MetadataValue<'ctx>)

Implementations§

source§

impl<'ctx> BasicMetadataValueEnum<'ctx>

source

pub fn is_array_value(self) -> bool

source

pub fn is_int_value(self) -> bool

source

pub fn is_float_value(self) -> bool

source

pub fn is_pointer_value(self) -> bool

source

pub fn is_struct_value(self) -> bool

source

pub fn is_vector_value(self) -> bool

source

pub fn is_metadata_value(self) -> bool

source

pub fn into_array_value(self) -> ArrayValue<'ctx>

source

pub fn into_int_value(self) -> IntValue<'ctx>

source

pub fn into_float_value(self) -> FloatValue<'ctx>

source

pub fn into_pointer_value(self) -> PointerValue<'ctx>

source

pub fn into_struct_value(self) -> StructValue<'ctx>

source

pub fn into_vector_value(self) -> VectorValue<'ctx>

source

pub fn into_metadata_value(self) -> MetadataValue<'ctx>

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for BasicMetadataValueEnum<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for BasicMetadataValueEnum<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for BasicMetadataValueEnum<'ctx>

source§

fn clone(&self) -> BasicMetadataValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicMetadataValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicMetadataValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<MetadataValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: MetadataValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for BasicMetadataValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +}

Variants§

§

ArrayValue(ArrayValue<'ctx>)

§

IntValue(IntValue<'ctx>)

§

FloatValue(FloatValue<'ctx>)

§

PointerValue(PointerValue<'ctx>)

§

StructValue(StructValue<'ctx>)

§

VectorValue(VectorValue<'ctx>)

§

MetadataValue(MetadataValue<'ctx>)

Implementations§

source§

impl<'ctx> BasicMetadataValueEnum<'ctx>

source

pub fn is_array_value(self) -> bool

source

pub fn is_int_value(self) -> bool

source

pub fn is_float_value(self) -> bool

source

pub fn is_pointer_value(self) -> bool

source

pub fn is_struct_value(self) -> bool

source

pub fn is_vector_value(self) -> bool

source

pub fn is_metadata_value(self) -> bool

source

pub fn into_array_value(self) -> ArrayValue<'ctx>

source

pub fn into_int_value(self) -> IntValue<'ctx>

source

pub fn into_float_value(self) -> FloatValue<'ctx>

source

pub fn into_pointer_value(self) -> PointerValue<'ctx>

source

pub fn into_struct_value(self) -> StructValue<'ctx>

source

pub fn into_vector_value(self) -> VectorValue<'ctx>

source

pub fn into_metadata_value(self) -> MetadataValue<'ctx>

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for BasicMetadataValueEnum<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for BasicMetadataValueEnum<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for BasicMetadataValueEnum<'ctx>

source§

fn clone(&self) -> BasicMetadataValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicMetadataValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicMetadataValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<MetadataValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: MetadataValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for BasicMetadataValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<MetadataValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicMetadataValueEnum<'ctx>

source§

impl<'ctx> Eq for BasicMetadataValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicMetadataValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> !Send for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> !Sync for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> Unpin for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicMetadataValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<MetadataValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicMetadataValueEnum<'ctx>

source§

impl<'ctx> Eq for BasicMetadataValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicMetadataValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> !Send for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> !Sync for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> Unpin for BasicMetadataValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicMetadataValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/enum.BasicValueEnum.html b/inkwell/values/enum.BasicValueEnum.html index 0835c2ddc..576584f1a 100644 --- a/inkwell/values/enum.BasicValueEnum.html +++ b/inkwell/values/enum.BasicValueEnum.html @@ -12,35 +12,35 @@
source

pub fn get_name(&self) -> &CStr

Get the name of the BasicValueEnum.

source

pub fn set_name(&self, name: &str)

Set name of the BasicValueEnum.

source

pub fn get_type(&self) -> BasicTypeEnum<'ctx>

source

pub fn is_array_value(self) -> bool

source

pub fn is_int_value(self) -> bool

source

pub fn is_float_value(self) -> bool

source

pub fn is_pointer_value(self) -> bool

source

pub fn is_struct_value(self) -> bool

source

pub fn is_vector_value(self) -> bool

source

pub fn into_array_value(self) -> ArrayValue<'ctx>

source

pub fn into_int_value(self) -> IntValue<'ctx>

source

pub fn into_float_value(self) -> FloatValue<'ctx>

source

pub fn into_pointer_value(self) -> PointerValue<'ctx>

source

pub fn into_struct_value(self) -> StructValue<'ctx>

source

pub fn into_vector_value(self) -> VectorValue<'ctx>

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for BasicValueEnum<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for BasicValueEnum<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for BasicValueEnum<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for BasicValueEnum<'ctx>

source§

fn clone(&self) -> BasicValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for BasicValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for BasicValueEnum<'ctx>

source§

fn clone(&self) -> BasicValueEnum<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for BasicValueEnum<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for BasicValueEnum<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<BasicValueEnum<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: BasicValueEnum<'ctx>) -> Self

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for BasicValueEnum<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicValueEnum<'ctx>

source§

impl<'ctx> Eq for BasicValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicValueEnum<'ctx>

§

impl<'ctx> !Send for BasicValueEnum<'ctx>

§

impl<'ctx> !Sync for BasicValueEnum<'ctx>

§

impl<'ctx> Unpin for BasicValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for BasicValueEnum<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for BasicValueEnum<'ctx>

source§

impl<'ctx> Eq for BasicValueEnum<'ctx>

source§

impl<'ctx> StructuralPartialEq for BasicValueEnum<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for BasicValueEnum<'ctx>

§

impl<'ctx> RefUnwindSafe for BasicValueEnum<'ctx>

§

impl<'ctx> !Send for BasicValueEnum<'ctx>

§

impl<'ctx> !Sync for BasicValueEnum<'ctx>

§

impl<'ctx> Unpin for BasicValueEnum<'ctx>

§

impl<'ctx> UnwindSafe for BasicValueEnum<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.ArrayValue.html b/inkwell/values/struct.ArrayValue.html index 791f3141c..a9ba917a1 100644 --- a/inkwell/values/struct.ArrayValue.html +++ b/inkwell/values/struct.ArrayValue.html @@ -43,27 +43,27 @@ if the value points to a constant string.

let result = CStr::from_bytes_with_nul(b"hello!\0").unwrap(); assert_eq!(string.get_string_constant(), Some(result));

Trait Implementations§

source§

impl<'ctx> AggregateValue<'ctx> for ArrayValue<'ctx>

source§

fn as_aggregate_value_enum(&self) -> AggregateValueEnum<'ctx>

Returns an enum containing a typed version of the AggregateValue.
source§

impl<'ctx> AnyValue<'ctx> for ArrayValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for ArrayValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for ArrayValue<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for ArrayValue<'ctx>

source§

fn clone(&self) -> ArrayValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ArrayValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for ArrayValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for ArrayValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for ArrayValue<'ctx>

source§

fn clone(&self) -> ArrayValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ArrayValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for ArrayValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: ArrayValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for ArrayValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for ArrayValue<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<ArrayValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for ArrayValue<'ctx>

source§

impl<'ctx> Eq for ArrayValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for ArrayValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for ArrayValue<'ctx>

§

impl<'ctx> RefUnwindSafe for ArrayValue<'ctx>

§

impl<'ctx> !Send for ArrayValue<'ctx>

§

impl<'ctx> !Sync for ArrayValue<'ctx>

§

impl<'ctx> Unpin for ArrayValue<'ctx>

§

impl<'ctx> UnwindSafe for ArrayValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for ArrayValue<'ctx>

source§

fn eq(&self, other: &ArrayValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for ArrayValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for ArrayValue<'ctx>

source§

impl<'ctx> Eq for ArrayValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for ArrayValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for ArrayValue<'ctx>

§

impl<'ctx> RefUnwindSafe for ArrayValue<'ctx>

§

impl<'ctx> !Send for ArrayValue<'ctx>

§

impl<'ctx> !Sync for ArrayValue<'ctx>

§

impl<'ctx> Unpin for ArrayValue<'ctx>

§

impl<'ctx> UnwindSafe for ArrayValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.FloatValue.html b/inkwell/values/struct.FloatValue.html index 714026119..646383abe 100644 --- a/inkwell/values/struct.FloatValue.html +++ b/inkwell/values/struct.FloatValue.html @@ -28,23 +28,23 @@ return an empty string.

assert_eq!(f64_1_2.get_constant(), Some((1.2, false)));
source

pub fn replace_all_uses_with(self, other: FloatValue<'ctx>)

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for FloatValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for FloatValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for FloatValue<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for FloatValue<'ctx>

source§

fn clone(&self) -> FloatValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for FloatValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FloatValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathValue<'ctx> for FloatValue<'ctx>

§

type BaseType = FloatType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> FloatValue<'ctx>

source§

impl<'ctx> From<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for FloatValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for FloatValue<'ctx>

source§

fn clone(&self) -> FloatValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for FloatValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FloatValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathValue<'ctx> for FloatValue<'ctx>

§

type BaseType = FloatType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> FloatValue<'ctx>

source§

impl<'ctx> From<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: FloatValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for FloatValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for FloatValue<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for FloatValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for FloatValue<'ctx>

source§

impl<'ctx> Eq for FloatValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for FloatValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for FloatValue<'ctx>

§

impl<'ctx> RefUnwindSafe for FloatValue<'ctx>

§

impl<'ctx> !Send for FloatValue<'ctx>

§

impl<'ctx> !Sync for FloatValue<'ctx>

§

impl<'ctx> Unpin for FloatValue<'ctx>

§

impl<'ctx> UnwindSafe for FloatValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FloatValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for FloatValue<'ctx>

source§

fn eq(&self, other: &FloatValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for FloatValue<'ctx>

source§

impl<'ctx> Eq for FloatValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for FloatValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for FloatValue<'ctx>

§

impl<'ctx> RefUnwindSafe for FloatValue<'ctx>

§

impl<'ctx> !Send for FloatValue<'ctx>

§

impl<'ctx> !Sync for FloatValue<'ctx>

§

impl<'ctx> Unpin for FloatValue<'ctx>

§

impl<'ctx> UnwindSafe for FloatValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.FunctionValue.html b/inkwell/values/struct.FunctionValue.html index 544fc214a..42a673aec 100644 --- a/inkwell/values/struct.FunctionValue.html +++ b/inkwell/values/struct.FunctionValue.html @@ -127,14 +127,14 @@ a PointerValue.

source

pub fn get_subprogram(self) -> Option<DISubprogram<'ctx>>

Get the debug info descriptor

source

pub fn get_section(&self) -> Option<&CStr>

Get the section to which this function belongs

source

pub fn set_section(self, section: Option<&str>)

Set the section to which this function should belong

-

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for FunctionValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for FunctionValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for FunctionValue<'ctx>

source§

fn clone(&self) -> FunctionValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for FunctionValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FunctionValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FunctionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for FunctionValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for FunctionValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for FunctionValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for FunctionValue<'ctx>

source§

fn clone(&self) -> FunctionValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for FunctionValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FunctionValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: FunctionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for FunctionValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for FunctionValue<'ctx>

source§

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for FunctionValue<'ctx>

source§

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PassManagerSubType for FunctionValue<'ctx>

§

type Input = Module<'ctx>

source§

unsafe fn create<I: Borrow<Self::Input>>(input: I) -> LLVMPassManagerRef

source§

unsafe fn run_in_pass_manager(&self, pass_manager: &PassManager<Self>) -> bool

source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for FunctionValue<'ctx>

source§

impl<'ctx> Eq for FunctionValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for FunctionValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for FunctionValue<'ctx>

§

impl<'ctx> RefUnwindSafe for FunctionValue<'ctx>

§

impl<'ctx> !Send for FunctionValue<'ctx>

§

impl<'ctx> !Sync for FunctionValue<'ctx>

§

impl<'ctx> Unpin for FunctionValue<'ctx>

§

impl<'ctx> UnwindSafe for FunctionValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where diff --git a/inkwell/values/struct.InstructionValue.html b/inkwell/values/struct.InstructionValue.html index 723eee6e9..d7a15a636 100644 --- a/inkwell/values/struct.InstructionValue.html +++ b/inkwell/values/struct.InstructionValue.html @@ -281,13 +281,13 @@ this gives the olt.

The clone will have no parent, and no name.

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for InstructionValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for InstructionValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: InstructionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for InstructionValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for InstructionValue<'ctx>

source§

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<InstructionValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for InstructionValue<'ctx>

source§

impl<'ctx> Eq for InstructionValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for InstructionValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for InstructionValue<'ctx>

§

impl<'ctx> RefUnwindSafe for InstructionValue<'ctx>

§

impl<'ctx> !Send for InstructionValue<'ctx>

§

impl<'ctx> !Sync for InstructionValue<'ctx>

§

impl<'ctx> Unpin for InstructionValue<'ctx>

§

impl<'ctx> UnwindSafe for InstructionValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq for InstructionValue<'ctx>

source§

fn eq(&self, other: &InstructionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for InstructionValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for FloatValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for InstructionValue<'ctx>

source§

impl<'ctx> Eq for InstructionValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for InstructionValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for InstructionValue<'ctx>

§

impl<'ctx> RefUnwindSafe for InstructionValue<'ctx>

§

impl<'ctx> !Send for InstructionValue<'ctx>

§

impl<'ctx> !Sync for InstructionValue<'ctx>

§

impl<'ctx> Unpin for InstructionValue<'ctx>

§

impl<'ctx> UnwindSafe for InstructionValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.IntValue.html b/inkwell/values/struct.IntValue.html index 519218771..5b224e748 100644 --- a/inkwell/values/struct.IntValue.html +++ b/inkwell/values/struct.IntValue.html @@ -52,23 +52,23 @@ example the address of a function casted to an integer.

assert_eq!(i8_all_ones.get_sign_extended_constant(), Some(-1));
source

pub fn replace_all_uses_with(self, other: IntValue<'ctx>)

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for IntValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for IntValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for IntValue<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for IntValue<'ctx>

source§

fn clone(&self) -> IntValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for IntValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for IntValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for IntValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for IntValue<'ctx>

source§

fn clone(&self) -> IntValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for IntValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for IntValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: IntValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for IntValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> IntMathValue<'ctx> for IntValue<'ctx>

§

type BaseType = IntType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> IntValue<'ctx>

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> IntMathValue<'ctx> for IntValue<'ctx>

§

type BaseType = IntType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> IntValue<'ctx>

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for IntValue<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for IntValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for IntValue<'ctx>

source§

impl<'ctx> Eq for IntValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for IntValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for IntValue<'ctx>

§

impl<'ctx> RefUnwindSafe for IntValue<'ctx>

§

impl<'ctx> !Send for IntValue<'ctx>

§

impl<'ctx> !Sync for IntValue<'ctx>

§

impl<'ctx> Unpin for IntValue<'ctx>

§

impl<'ctx> UnwindSafe for IntValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for IntValue<'ctx>

source§

fn eq(&self, other: &IntValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for IntValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for IntValue<'ctx>

source§

impl<'ctx> Eq for IntValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for IntValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for IntValue<'ctx>

§

impl<'ctx> RefUnwindSafe for IntValue<'ctx>

§

impl<'ctx> !Send for IntValue<'ctx>

§

impl<'ctx> !Sync for IntValue<'ctx>

§

impl<'ctx> Unpin for IntValue<'ctx>

§

impl<'ctx> UnwindSafe for IntValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.MetadataValue.html b/inkwell/values/struct.MetadataValue.html index d5340b37d..3d93dc475 100644 --- a/inkwell/values/struct.MetadataValue.html +++ b/inkwell/values/struct.MetadataValue.html @@ -5,17 +5,17 @@
source

pub fn get_name(&self) -> &CStr

Get name of the MetadataValue.

source

pub fn is_node(self) -> bool

source

pub fn is_string(self) -> bool

source

pub fn get_string_value(&self) -> Option<&CStr>

source

pub fn get_node_size(self) -> u32

source

pub fn get_node_values(self) -> Vec<BasicMetadataValueEnum<'ctx>>

source

pub fn print_to_stderr(self)

source

pub fn replace_all_uses_with(self, other: &MetadataValue<'ctx>)

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for MetadataValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for MetadataValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for MetadataValue<'ctx>

source§

fn clone(&self) -> MetadataValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for MetadataValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for MetadataValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<MetadataValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: MetadataValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<MetadataValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: MetadataValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for MetadataValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for MetadataValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for MetadataValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<MetadataValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<MetadataValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<MetadataValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for MetadataValue<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for MetadataValue<'ctx>

source§

impl<'ctx> Eq for MetadataValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for MetadataValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for MetadataValue<'ctx>

§

impl<'ctx> RefUnwindSafe for MetadataValue<'ctx>

§

impl<'ctx> !Send for MetadataValue<'ctx>

§

impl<'ctx> !Sync for MetadataValue<'ctx>

§

impl<'ctx> Unpin for MetadataValue<'ctx>

§

impl<'ctx> UnwindSafe for MetadataValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq for MetadataValue<'ctx>

source§

fn eq(&self, other: &MetadataValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for MetadataValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for MetadataValue<'ctx>

source§

impl<'ctx> Eq for MetadataValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for MetadataValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for MetadataValue<'ctx>

§

impl<'ctx> RefUnwindSafe for MetadataValue<'ctx>

§

impl<'ctx> !Send for MetadataValue<'ctx>

§

impl<'ctx> !Sync for MetadataValue<'ctx>

§

impl<'ctx> Unpin for MetadataValue<'ctx>

§

impl<'ctx> UnwindSafe for MetadataValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.PhiValue.html b/inkwell/values/struct.PhiValue.html index 4c9b2d957..5fc4d2a73 100644 --- a/inkwell/values/struct.PhiValue.html +++ b/inkwell/values/struct.PhiValue.html @@ -20,13 +20,13 @@ the Phi’s containing basic block.

return an empty string.

source

pub fn set_name(self, name: &str)

source

pub fn is_null(self) -> bool

source

pub fn is_undef(self) -> bool

source

pub fn as_instruction(self) -> InstructionValue<'ctx>

source

pub fn replace_all_uses_with(self, other: &PhiValue<'ctx>)

source

pub fn as_basic_value(self) -> BasicValueEnum<'ctx>

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for PhiValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for PhiValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> Clone for PhiValue<'ctx>

source§

fn clone(&self) -> PhiValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for PhiValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for PhiValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<PhiValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PhiValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for PhiValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PhiValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PhiValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PhiValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PhiValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PhiValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PhiValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for PhiValue<'ctx>

source§

fn eq(&self, other: &PhiValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for PhiValue<'ctx>

source§

impl<'ctx> Eq for PhiValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for PhiValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for PhiValue<'ctx>

§

impl<'ctx> RefUnwindSafe for PhiValue<'ctx>

§

impl<'ctx> !Send for PhiValue<'ctx>

§

impl<'ctx> !Sync for PhiValue<'ctx>

§

impl<'ctx> Unpin for PhiValue<'ctx>

§

impl<'ctx> UnwindSafe for PhiValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PhiValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for PhiValue<'ctx>

source§

impl<'ctx> Eq for PhiValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for PhiValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for PhiValue<'ctx>

§

impl<'ctx> RefUnwindSafe for PhiValue<'ctx>

§

impl<'ctx> !Send for PhiValue<'ctx>

§

impl<'ctx> !Sync for PhiValue<'ctx>

§

impl<'ctx> Unpin for PhiValue<'ctx>

§

impl<'ctx> UnwindSafe for PhiValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.PointerValue.html b/inkwell/values/struct.PointerValue.html index ed2ba44c3..1bb7317a1 100644 --- a/inkwell/values/struct.PointerValue.html +++ b/inkwell/values/struct.PointerValue.html @@ -26,23 +26,23 @@ will return an empty string.

self, ptr_type: PointerType<'ctx> ) -> PointerValue<'ctx>
source

pub fn replace_all_uses_with(self, other: PointerValue<'ctx>)

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for PointerValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for PointerValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for PointerValue<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for PointerValue<'ctx>

source§

fn clone(&self) -> PointerValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for PointerValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for PointerValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for PointerValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for PointerValue<'ctx>

source§

fn clone(&self) -> PointerValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for PointerValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for PointerValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for PointerValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> IntMathValue<'ctx> for PointerValue<'ctx>

§

type BaseType = IntType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> PointerValue<'ctx>

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> IntMathValue<'ctx> for PointerValue<'ctx>

§

type BaseType = IntType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> PointerValue<'ctx>

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for PointerValue<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PointerMathValue<'ctx> for PointerValue<'ctx>

§

type BaseType = PointerType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> PointerValue<'ctx>

source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for PointerValue<'ctx>

source§

impl<'ctx> Eq for PointerValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for PointerValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for PointerValue<'ctx>

§

impl<'ctx> RefUnwindSafe for PointerValue<'ctx>

§

impl<'ctx> !Send for PointerValue<'ctx>

§

impl<'ctx> !Sync for PointerValue<'ctx>

§

impl<'ctx> Unpin for PointerValue<'ctx>

§

impl<'ctx> UnwindSafe for PointerValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for PointerValue<'ctx>

source§

fn eq(&self, other: &PointerValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PointerMathValue<'ctx> for PointerValue<'ctx>

§

type BaseType = PointerType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> PointerValue<'ctx>

source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PointerValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for PointerValue<'ctx>

source§

impl<'ctx> Eq for PointerValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for PointerValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for PointerValue<'ctx>

§

impl<'ctx> RefUnwindSafe for PointerValue<'ctx>

§

impl<'ctx> !Send for PointerValue<'ctx>

§

impl<'ctx> !Sync for PointerValue<'ctx>

§

impl<'ctx> Unpin for PointerValue<'ctx>

§

impl<'ctx> UnwindSafe for PointerValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.StructValue.html b/inkwell/values/struct.StructValue.html index a17f691c0..cec0e87b3 100644 --- a/inkwell/values/struct.StructValue.html +++ b/inkwell/values/struct.StructValue.html @@ -48,27 +48,27 @@ return an empty string.

source

pub fn set_name(&self, name: &str)

Get name of the StructValue.

source

pub fn get_type(self) -> StructType<'ctx>

source

pub fn is_null(self) -> bool

source

pub fn is_undef(self) -> bool

source

pub fn print_to_stderr(self)

source

pub fn as_instruction(self) -> Option<InstructionValue<'ctx>>

source

pub fn replace_all_uses_with(self, other: StructValue<'ctx>)

Trait Implementations§

source§

impl<'ctx> AggregateValue<'ctx> for StructValue<'ctx>

source§

fn as_aggregate_value_enum(&self) -> AggregateValueEnum<'ctx>

Returns an enum containing a typed version of the AggregateValue.
source§

impl<'ctx> AnyValue<'ctx> for StructValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for StructValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for StructValue<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for StructValue<'ctx>

source§

fn clone(&self) -> StructValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for StructValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for StructValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for StructValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for StructValue<'ctx>

source§

fn clone(&self) -> StructValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for StructValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for StructValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> From<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: StructValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for StructValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for StructValue<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> PartialEq<AggregateValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AggregateValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for StructValue<'ctx>

source§

impl<'ctx> Eq for StructValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for StructValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for StructValue<'ctx>

§

impl<'ctx> RefUnwindSafe for StructValue<'ctx>

§

impl<'ctx> !Send for StructValue<'ctx>

§

impl<'ctx> !Sync for StructValue<'ctx>

§

impl<'ctx> Unpin for StructValue<'ctx>

§

impl<'ctx> UnwindSafe for StructValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for StructValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for AggregateValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<StructValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for StructValue<'ctx>

source§

fn eq(&self, other: &StructValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> TryFrom<AggregateValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AggregateValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for StructValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for StructValue<'ctx>

source§

impl<'ctx> Eq for StructValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for StructValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for StructValue<'ctx>

§

impl<'ctx> RefUnwindSafe for StructValue<'ctx>

§

impl<'ctx> !Send for StructValue<'ctx>

§

impl<'ctx> !Sync for StructValue<'ctx>

§

impl<'ctx> Unpin for StructValue<'ctx>

§

impl<'ctx> UnwindSafe for StructValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/inkwell/values/struct.VectorValue.html b/inkwell/values/struct.VectorValue.html index ddf04993f..970fc4982 100644 --- a/inkwell/values/struct.VectorValue.html +++ b/inkwell/values/struct.VectorValue.html @@ -27,23 +27,23 @@ return an empty string.

right: VectorValue<'ctx>, mask: VectorValue<'ctx> ) -> VectorValue<'ctx>

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for VectorValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

Returns whether the value is poison
source§

impl AsValueRef for VectorValue<'_>

source§

fn as_value_ref(&self) -> LLVMValueRef

source§

impl<'ctx> BasicValue<'ctx> for VectorValue<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction -and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for VectorValue<'ctx>

source§

fn clone(&self) -> VectorValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for VectorValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for VectorValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathValue<'ctx> for VectorValue<'ctx>

§

type BaseType = VectorType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> VectorValue<'ctx>

source§

impl<'ctx> From<VectorValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for VectorValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +and so are convertible into an InstructionValue

source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for VectorValue<'ctx>

source§

fn clone(&self) -> VectorValue<'ctx>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'ctx> Debug for VectorValue<'ctx>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for VectorValue<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'ctx> FloatMathValue<'ctx> for VectorValue<'ctx>

§

type BaseType = VectorType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> VectorValue<'ctx>

source§

impl<'ctx> From<VectorValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: VectorValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for VectorValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> IntMathValue<'ctx> for VectorValue<'ctx>

§

type BaseType = VectorType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> VectorValue<'ctx>

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> IntMathValue<'ctx> for VectorValue<'ctx>

§

type BaseType = VectorType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> VectorValue<'ctx>

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for VectorValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for VectorValue<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PointerMathValue<'ctx> for VectorValue<'ctx>

§

type BaseType = VectorType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> VectorValue<'ctx>

source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for VectorValue<'ctx>

source§

impl<'ctx> Eq for VectorValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for VectorValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for VectorValue<'ctx>

§

impl<'ctx> RefUnwindSafe for VectorValue<'ctx>

§

impl<'ctx> !Send for VectorValue<'ctx>

§

impl<'ctx> !Sync for VectorValue<'ctx>

§

impl<'ctx> Unpin for VectorValue<'ctx>

§

impl<'ctx> UnwindSafe for VectorValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where +sufficient, and should not be overridden without very good reason.

source§

impl<'ctx> PartialEq<VectorValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PartialEq for VectorValue<'ctx>

source§

fn eq(&self, other: &VectorValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'ctx> PointerMathValue<'ctx> for VectorValue<'ctx>

§

type BaseType = VectorType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> VectorValue<'ctx>

source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for VectorValue<'ctx>

§

type Error = ()

The type returned in the event of a conversion error.
source§

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for VectorValue<'ctx>

source§

impl<'ctx> Eq for VectorValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for VectorValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for VectorValue<'ctx>

§

impl<'ctx> RefUnwindSafe for VectorValue<'ctx>

§

impl<'ctx> !Send for VectorValue<'ctx>

§

impl<'ctx> !Sync for VectorValue<'ctx>

§

impl<'ctx> Unpin for VectorValue<'ctx>

§

impl<'ctx> UnwindSafe for VectorValue<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/proc_macro2/all.html b/proc_macro2/all.html index ceab7bcb9..9150d6fbb 100644 --- a/proc_macro2/all.html +++ b/proc_macro2/all.html @@ -1,2 +1,2 @@ -List of all items in this crate
+List of all items in this crate

List of all items

Structs

Enums

\ No newline at end of file diff --git a/proc_macro2/enum.Delimiter.html b/proc_macro2/enum.Delimiter.html index 3e546f04a..22e1c289f 100644 --- a/proc_macro2/enum.Delimiter.html +++ b/proc_macro2/enum.Delimiter.html @@ -1,4 +1,4 @@ -Delimiter in proc_macro2 - Rust
+Delimiter in proc_macro2 - Rust

Enum proc_macro2::Delimiter

source · 
pub enum Delimiter {
     Parenthesis,
     Brace,
diff --git a/proc_macro2/enum.Spacing.html b/proc_macro2/enum.Spacing.html
index 6554a01d6..15f62da6c 100644
--- a/proc_macro2/enum.Spacing.html
+++ b/proc_macro2/enum.Spacing.html
@@ -1,4 +1,4 @@
-Spacing in proc_macro2 - Rust

+Spacing in proc_macro2 - Rust

     
Enum proc_macro2::Spacing
source · 
pub enum Spacing {
     Alone,
     Joint,
diff --git a/proc_macro2/enum.TokenTree.html b/proc_macro2/enum.TokenTree.html
index 90d1e7311..884f07267 100644
--- a/proc_macro2/enum.TokenTree.html
+++ b/proc_macro2/enum.TokenTree.html
@@ -1,4 +1,4 @@
-TokenTree in proc_macro2 - Rust

+TokenTree in proc_macro2 - Rust

     
Enum proc_macro2::TokenTree
source · 
pub enum TokenTree {
     Group(Group),
     Ident(Ident),
@@ -16,11 +16,11 @@ the contained token or a delimited stream.

 the span of each of the internal tokens, this will simply delegate to
 the set_span method of each variant.

Trait Implementations§

source§

impl Clone for TokenTree

source§

fn clone(&self) -> TokenTree

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for TokenTree

Prints token tree in a form convenient for debugging.

-
source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TokenTree

Prints the token tree as a string that is supposed to be losslessly +

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TokenTree

Prints the token tree as a string that is supposed to be losslessly convertible back into the same token tree (modulo spans), except for possibly TokenTree::Groups with Delimiter::None delimiters and negative numeric literals.

-
source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<TokenTree> for TokenStream

source§

fn extend<I: IntoIterator<Item = TokenTree>>(&mut self, streams: I)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<Group> for TokenTree

source§

fn from(g: Group) -> Self

Converts to this type from the input type.
source§

impl From<Ident> for TokenTree

source§

fn from(g: Ident) -> Self

Converts to this type from the input type.
source§

impl From<Literal> for TokenTree

source§

fn from(g: Literal) -> Self

Converts to this type from the input type.
source§

impl From<Punct> for TokenTree

source§

fn from(g: Punct) -> Self

Converts to this type from the input type.
source§

impl From<TokenTree> for TokenStream

source§

fn from(token: TokenTree) -> Self

Converts to this type from the input type.
source§

impl FromIterator<TokenTree> for TokenStream

Collects a number of token trees into a single stream.

+
source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<TokenTree> for TokenStream

source§

fn extend<I: IntoIterator<Item = TokenTree>>(&mut self, streams: I)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<Group> for TokenTree

source§

fn from(g: Group) -> Self

Converts to this type from the input type.
source§

impl From<Ident> for TokenTree

source§

fn from(g: Ident) -> Self

Converts to this type from the input type.
source§

impl From<Literal> for TokenTree

source§

fn from(g: Literal) -> Self

Converts to this type from the input type.
source§

impl From<Punct> for TokenTree

source§

fn from(g: Punct) -> Self

Converts to this type from the input type.
source§

impl From<TokenTree> for TokenStream

source§

fn from(token: TokenTree) -> Self

Converts to this type from the input type.
source§

impl FromIterator<TokenTree> for TokenStream

Collects a number of token trees into a single stream.

source§

fn from_iter<I: IntoIterator<Item = TokenTree>>(streams: I) -> Self

Creates a value from an iterator. Read more

Auto Trait Implementations§

§

impl Freeze for TokenTree

§

impl RefUnwindSafe for TokenTree

§

impl !Send for TokenTree

§

impl !Sync for TokenTree

§

impl Unpin for TokenTree

§

impl UnwindSafe for TokenTree

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where diff --git a/proc_macro2/extra/index.html b/proc_macro2/extra/index.html index d3792d7a0..b5d3c855a 100644 --- a/proc_macro2/extra/index.html +++ b/proc_macro2/extra/index.html @@ -1,4 +1,4 @@ -proc_macro2::extra - Rust
+proc_macro2::extra - Rust

Module proc_macro2::extra

source ·
Expand description

Items which do not have a correspondence to any API in the proc_macro crate, but are necessary to include in proc-macro2.

Structs§

  • DelimSpan
    An object that holds a Group’s span_open() and span_close() together diff --git a/proc_macro2/extra/struct.DelimSpan.html b/proc_macro2/extra/struct.DelimSpan.html index ce41a4425..292294f05 100644 --- a/proc_macro2/extra/struct.DelimSpan.html +++ b/proc_macro2/extra/struct.DelimSpan.html @@ -1,4 +1,4 @@ -DelimSpan in proc_macro2::extra - Rust
    +DelimSpan in proc_macro2::extra - Rust

    Struct proc_macro2::extra::DelimSpan

    source · 
    pub struct DelimSpan { /* private fields */ }
    Expand description

    An object that holds a Group’s span_open() and span_close() together in a more compact representation than holding those 2 spans individually.

    Implementations§

    source§

    impl DelimSpan

    source

    pub fn join(&self) -> Span

    Returns a span covering the entire delimited group.

    diff --git a/proc_macro2/index.html b/proc_macro2/index.html index 0e3be1170..92e614bf2 100644 --- a/proc_macro2/index.html +++ b/proc_macro2/index.html @@ -1,4 +1,4 @@ -proc_macro2 - Rust

§

type Error = E

The error type that can be returned if some error occurs during deserialization.
§

type Variant = UnitOnly<E>

The Visitor that will be used to deserialize the content of the enum variant.
source§

fn variant_seed<T>( self, diff --git a/serde/de/value/struct.Error.html b/serde/de/value/struct.Error.html index 5e756e4eb..847349c22 100644 --- a/serde/de/value/struct.Error.html +++ b/serde/de/value/struct.Error.html @@ -1,7 +1,9 @@ Error in serde::de::value - Rust

Struct serde::de::value::Error

source · 
pub struct Error { /* private fields */ }
Expand description

A minimal representation of all possible errors that can occur using the IntoDeserializer trait.

-

Trait Implementations§

source§

impl Clone for Error

source§

fn clone(&self) -> Error

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for Error

source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where +

Trait Implementations§

source§

impl Clone for Error

source§

fn clone(&self) -> Error

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for Error

source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where + T: Display,

Used when a Serialize implementation encounters any error +while serializing a type. Read more
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where T: Display,

Raised when there is general error when deserializing a type. Read more
source§

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting. Read more
source§

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason. Read more
source§

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains @@ -10,9 +12,7 @@ unrecognized name.
source§

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.
source§

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the -same field.
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where - T: Display,

Used when a Serialize implementation encounters any error -while serializing a type. Read more
source§

impl PartialEq for Error

source§

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used +same field.
source§

impl PartialEq for Error

source§

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/serde/de/value/struct.MapAccessDeserializer.html b/serde/de/value/struct.MapAccessDeserializer.html index c0af532bc..5d0bf302e 100644 --- a/serde/de/value/struct.MapAccessDeserializer.html +++ b/serde/de/value/struct.MapAccessDeserializer.html @@ -2,7 +2,7 @@

Struct serde::de::value::MapAccessDeserializer

source · 
pub struct MapAccessDeserializer<A> { /* private fields */ }
Expand description

A deserializer holding a MapAccess.

Implementations§

source§

impl<A> MapAccessDeserializer<A>

source

pub fn new(map: A) -> Self

Construct a new MapAccessDeserializer<A>.

Trait Implementations§

source§

impl<A: Clone> Clone for MapAccessDeserializer<A>

source§

fn clone(&self) -> MapAccessDeserializer<A>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<A: Debug> Debug for MapAccessDeserializer<A>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'de, A> Deserializer<'de> for MapAccessDeserializer<A>
where - A: MapAccess<'de>,

§

type Error = <A as MapAccess<'de>>::Error

The error type that can be returned if some error occurs during + A: MapAccess<'de>,

§

type Error = <A as MapAccess<'de>>::Error

The error type that can be returned if some error occurs during deserialization.
source§

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input. Read more
source§

fn deserialize_enum<V>( @@ -152,7 +152,7 @@ field or the discriminant of an enum variant.

Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored. Read more
source§

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form. Read more
source§

impl<'de, A> EnumAccess<'de> for MapAccessDeserializer<A>
where - A: MapAccess<'de>,

§

type Error = <A as MapAccess<'de>>::Error

The error type that can be returned if some error occurs during + A: MapAccess<'de>,
§

type Error = <A as MapAccess<'de>>::Error

The error type that can be returned if some error occurs during deserialization.
§

type Variant = MapAsEnum<A>

The Visitor that will be used to deserialize the content of the enum variant.
source§

fn variant_seed<T>( self, diff --git a/serde/de/value/struct.MapDeserializer.html b/serde/de/value/struct.MapDeserializer.html index f47b78ae2..bd49f3e08 100644 --- a/serde/de/value/struct.MapDeserializer.html +++ b/serde/de/value/struct.MapDeserializer.html @@ -21,7 +21,7 @@ I::Item: Pair, <I::Item as Pair>::First: IntoDeserializer<'de, E>, <I::Item as Pair>::Second: IntoDeserializer<'de, E>, - E: Error,

§

type Error = E

The error type that can be returned if some error occurs during + E: Error,
§

type Error = E

The error type that can be returned if some error occurs during deserialization.
source§

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input. Read more
source§

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>
where @@ -172,7 +172,7 @@ deserialize their human-readable form. Item: Pair, <I::Item as Pair>::First: IntoDeserializer<'de, E>, <I::Item as Pair>::Second: IntoDeserializer<'de, E>, - E: Error,

§

type Error = E

The error type that can be returned if some error occurs during + E: Error,
§

type Error = E

The error type that can be returned if some error occurs during deserialization.
source§

fn next_key_seed<T>(&mut self, seed: T) -> Result<Option<T::Value>, Self::Error>
where T: DeserializeSeed<'de>,

This returns Ok(Some(key)) for the next key in the map, or Ok(None) if there are no more remaining entries. Read more
source§

fn next_value_seed<T>(&mut self, seed: T) -> Result<T::Value, Self::Error>
where @@ -183,7 +183,7 @@ if there are no more remaining entries. Result<Option<(TK::Value, TV::Value)>, Self::Error>
where TK: DeserializeSeed<'de>, TV: DeserializeSeed<'de>,

This returns Ok(Some((key, value))) for the next (key-value) pair in -the map, or Ok(None) if there are no more remaining items. Read more
source§

fn size_hint(&self) -> Option<usize>

Returns the number of entries remaining in the map, if known.
source§

fn next_key<K>(&mut self) -> Result<Option<K>, Self::Error>
where +the map, or Ok(None) if there are no more remaining items. Read more

source§

fn size_hint(&self) -> Option<usize>

Returns the number of entries remaining in the map, if known.
source§

fn next_key<K>(&mut self) -> Result<Option<K>, Self::Error>
where K: Deserialize<'de>,

This returns Ok(Some(key)) for the next key in the map, or Ok(None) if there are no more remaining entries. Read more
source§

fn next_value<V>(&mut self) -> Result<V, Self::Error>
where V: Deserialize<'de>,

This returns a Ok(value) for the next value in the map. Read more
source§

fn next_entry<K, V>(&mut self) -> Result<Option<(K, V)>, Self::Error>
where @@ -194,13 +194,13 @@ the map, or Ok(None) if there are no more remaining items. Item: Pair, <I::Item as Pair>::First: IntoDeserializer<'de, E>, <I::Item as Pair>::Second: IntoDeserializer<'de, E>, - E: Error,

§

type Error = E

The error type that can be returned if some error occurs during + E: Error,
§

type Error = E

The error type that can be returned if some error occurs during deserialization.
source§

fn next_element_seed<T>( &mut self, seed: T ) -> Result<Option<T::Value>, Self::Error>
where T: DeserializeSeed<'de>,

This returns Ok(Some(value)) for the next value in the sequence, or -Ok(None) if there are no more remaining items. Read more
source§

fn size_hint(&self) -> Option<usize>

Returns the number of elements remaining in the sequence, if known.
source§

fn next_element<T>(&mut self) -> Result<Option<T>, Self::Error>
where +Ok(None) if there are no more remaining items. Read more

source§

fn size_hint(&self) -> Option<usize>

Returns the number of elements remaining in the sequence, if known.
source§

fn next_element<T>(&mut self) -> Result<Option<T>, Self::Error>
where T: Deserialize<'de>,

This returns Ok(Some(value)) for the next value in the sequence, or Ok(None) if there are no more remaining items. Read more

Auto Trait Implementations§

§

impl<'de, I, E> Freeze for MapDeserializer<'de, I, E>
where I: Freeze, diff --git a/serde/de/value/struct.StringDeserializer.html b/serde/de/value/struct.StringDeserializer.html index 4cad12880..4cc9832dd 100644 --- a/serde/de/value/struct.StringDeserializer.html +++ b/serde/de/value/struct.StringDeserializer.html @@ -1,7 +1,7 @@ StringDeserializer in serde::de::value - Rust

Struct serde::de::value::StringDeserializer

source · 
pub struct StringDeserializer<E> { /* private fields */ }
Expand description

A deserializer holding a String.

Implementations§

source§

impl<E> StringDeserializer<E>

source

pub fn new(value: String) -> Self

Trait Implementations§

source§

impl<E> Clone for StringDeserializer<E>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<E> Debug for StringDeserializer<E>

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'de, E> Deserializer<'de> for StringDeserializer<E>
where - E: Error,

§

type Error = E

The error type that can be returned if some error occurs during + E: Error,

§

type Error = E

The error type that can be returned if some error occurs during deserialization.
source§

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input. Read more
source§

fn deserialize_enum<V>( @@ -151,7 +151,7 @@ field or the discriminant of an enum variant.

Visitor<'de>,
Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored. Read more
source§

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form. Read more
source§

impl<'de, E> EnumAccess<'de> for StringDeserializer<E>
where - E: Error,

§

type Error = E

The error type that can be returned if some error occurs during + E: Error,
§

type Error = E

The error type that can be returned if some error occurs during deserialization.
§

type Variant = UnitOnly<E>

The Visitor that will be used to deserialize the content of the enum variant.
source§

fn variant_seed<T>( self, diff --git a/serde/ser/struct.Impossible.html b/serde/ser/struct.Impossible.html index 4e44d7cdf..5060bb81b 100644 --- a/serde/ser/struct.Impossible.html +++ b/serde/ser/struct.Impossible.html @@ -25,35 +25,35 @@ corresponding to the Serializer /* other Serializer methods */ }

Trait Implementations§

source§

impl<Ok, Error> SerializeMap for Impossible<Ok, Error>
where - Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_key<T>(&mut self, key: &T) -> Result<(), Error>
where + Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_key<T>(&mut self, key: &T) -> Result<(), Error>
where T: ?Sized + Serialize,

Serialize a map key. Read more
source§

fn serialize_value<T>(&mut self, value: &T) -> Result<(), Error>
where - T: ?Sized + Serialize,

Serialize a map value. Read more
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a map.
source§

fn serialize_entry<K, V>( + T: ?Sized + Serialize,

Serialize a map value. Read more
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a map.
source§

fn serialize_entry<K, V>( &mut self, key: &K, value: &V ) -> Result<(), Self::Error>
where K: ?Sized + Serialize, V: ?Sized + Serialize,

Serialize a map entry consisting of a key and a value. Read more
source§

impl<Ok, Error> SerializeSeq for Impossible<Ok, Error>
where - Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_element<T>(&mut self, value: &T) -> Result<(), Error>
where - T: ?Sized + Serialize,

Serialize a sequence element.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a sequence.
source§

impl<Ok, Error> SerializeStruct for Impossible<Ok, Error>
where - Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>( + Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_element<T>(&mut self, value: &T) -> Result<(), Error>
where + T: ?Sized + Serialize,

Serialize a sequence element.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a sequence.
source§

impl<Ok, Error> SerializeStruct for Impossible<Ok, Error>
where + Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>( &mut self, key: &'static str, value: &T ) -> Result<(), Error>
where - T: ?Sized + Serialize,

Serialize a struct field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a struct.
source§

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>

Indicate that a struct field has been skipped. Read more
source§

impl<Ok, Error> SerializeStructVariant for Impossible<Ok, Error>
where - Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>( + T: ?Sized + Serialize,

Serialize a struct field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a struct.
source§

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>

Indicate that a struct field has been skipped. Read more
source§

impl<Ok, Error> SerializeStructVariant for Impossible<Ok, Error>
where + Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>( &mut self, key: &'static str, value: &T ) -> Result<(), Error>
where - T: ?Sized + Serialize,

Serialize a struct variant field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a struct variant.
source§

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>

Indicate that a struct variant field has been skipped. Read more
source§

impl<Ok, Error> SerializeTuple for Impossible<Ok, Error>
where + T: ?Sized + Serialize,

Serialize a struct variant field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a struct variant.
source§

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>

Indicate that a struct variant field has been skipped. Read more
source§

impl<Ok, Error> SerializeTuple for Impossible<Ok, Error>
where Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_element<T>(&mut self, value: &T) -> Result<(), Error>
where T: ?Sized + Serialize,

Serialize a tuple element.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a tuple.
source§

impl<Ok, Error> SerializeTupleStruct for Impossible<Ok, Error>
where - Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>(&mut self, value: &T) -> Result<(), Error>
where - T: ?Sized + Serialize,

Serialize a tuple struct field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a tuple struct.
source§

impl<Ok, Error> SerializeTupleVariant for Impossible<Ok, Error>
where - Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>(&mut self, value: &T) -> Result<(), Error>
where - T: ?Sized + Serialize,

Serialize a tuple variant field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a tuple variant.

Auto Trait Implementations§

§

impl<Ok, Error> Freeze for Impossible<Ok, Error>

§

impl<Ok, Error> RefUnwindSafe for Impossible<Ok, Error>
where + Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>(&mut self, value: &T) -> Result<(), Error>
where + T: ?Sized + Serialize,

Serialize a tuple struct field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a tuple struct.
source§

impl<Ok, Error> SerializeTupleVariant for Impossible<Ok, Error>
where + Error: Error,

§

type Ok = Ok

Must match the Ok type of our Serializer.
§

type Error = Error

Must match the Error type of our Serializer.
source§

fn serialize_field<T>(&mut self, value: &T) -> Result<(), Error>
where + T: ?Sized + Serialize,

Serialize a tuple variant field.
source§

fn end(self) -> Result<Ok, Error>

Finish serializing a tuple variant.

Auto Trait Implementations§

§

impl<Ok, Error> Freeze for Impossible<Ok, Error>

§

impl<Ok, Error> RefUnwindSafe for Impossible<Ok, Error>
where Error: RefUnwindSafe, Ok: RefUnwindSafe,

§

impl<Ok, Error> Send for Impossible<Ok, Error>
where Error: Send, diff --git a/src/anyhow/backtrace.rs.html b/src/anyhow/backtrace.rs.html index c3183700b..0bfdf9c14 100644 --- a/src/anyhow/backtrace.rs.html +++ b/src/anyhow/backtrace.rs.html @@ -1,4 +1,4 @@ -backtrace.rs - source

Mutably access an element of this map. Panics if the given key is not present in the map.

-
source§

fn index_mut(&mut self, index: &Q) -> &mut Value

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'a> IntoIterator for &'a Map<String, Value>

§

type Item = (&'a String, &'a Value)

The type of the elements being iterated over.
§

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a> IntoIterator for &'a mut Map<String, Value>

§

type Item = (&'a String, &'a mut Value)

The type of the elements being iterated over.
§

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for Map<String, Value>

§

type Item = (String, Value)

The type of the elements being iterated over.
§

type IntoIter = IntoIter

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl PartialEq for Map<String, Value>

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used +
source§

fn index_mut(&mut self, index: &Q) -> &mut Value

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'a> IntoIterator for &'a Map<String, Value>

§

type Item = (&'a String, &'a Value)

The type of the elements being iterated over.
§

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a> IntoIterator for &'a mut Map<String, Value>

§

type Item = (&'a String, &'a mut Value)

The type of the elements being iterated over.
§

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for Map<String, Value>

§

type Item = (String, Value)

The type of the elements being iterated over.
§

type IntoIter = IntoIter

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl PartialEq for Map<String, Value>

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Map<String, Value>

source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<K, V> Freeze for Map<K, V>

§

impl<K, V> RefUnwindSafe for Map<K, V>
where diff --git a/toml/value/enum.Value.html b/toml/value/enum.Value.html index 849104a30..dc9acec36 100644 --- a/toml/value/enum.Value.html +++ b/toml/value/enum.Value.html @@ -211,7 +211,7 @@ field or the discriminant of an enum variant.

Result<<V as Visitor<'de>>::Value, Self::Error>
where V: Visitor<'de>,
Hint that the Deserialize type is expecting an u128 value. Read more
source§

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to -deserialize their human-readable form. Read more
source§

impl Display for Value

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a> From<&'a str> for Value

source§

fn from(val: &'a str) -> Value

Converts to this type from the input type.
source§

impl<S: Into<String>, V: Into<Value>> From<BTreeMap<S, V>> for Value

source§

fn from(val: BTreeMap<S, V>) -> Value

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(val: Datetime) -> Value

Converts to this type from the input type.
source§

impl<S: Into<String> + Hash + Eq, V: Into<Value>> From<HashMap<S, V>> for Value

source§

fn from(val: HashMap<S, V>) -> Value

Converts to this type from the input type.
source§

impl From<Map<String, Value>> for Value

source§

fn from(val: Table) -> Value

Converts to this type from the input type.
source§

impl From<String> for Value

source§

fn from(val: String) -> Value

Converts to this type from the input type.
source§

impl<V: Into<Value>> From<Vec<V>> for Value

source§

fn from(val: Vec<V>) -> Value

Converts to this type from the input type.
source§

impl From<bool> for Value

source§

fn from(val: bool) -> Value

Converts to this type from the input type.
source§

impl From<f32> for Value

source§

fn from(val: f32) -> Value

Converts to this type from the input type.
source§

impl From<f64> for Value

source§

fn from(val: f64) -> Value

Converts to this type from the input type.
source§

impl From<i32> for Value

source§

fn from(val: i32) -> Value

Converts to this type from the input type.
source§

impl From<i64> for Value

source§

fn from(val: i64) -> Value

Converts to this type from the input type.
source§

impl From<i8> for Value

source§

fn from(val: i8) -> Value

Converts to this type from the input type.
source§

impl From<u32> for Value

source§

fn from(val: u32) -> Value

Converts to this type from the input type.
source§

impl From<u8> for Value

source§

fn from(val: u8) -> Value

Converts to this type from the input type.
source§

impl FromStr for Value

§

type Err = Error

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Value, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl<I> Index<I> for Value
where +deserialize their human-readable form. Read more

source§

impl Display for Value

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a> From<&'a str> for Value

source§

fn from(val: &'a str) -> Value

Converts to this type from the input type.
source§

impl<S: Into<String>, V: Into<Value>> From<BTreeMap<S, V>> for Value

source§

fn from(val: BTreeMap<S, V>) -> Value

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(val: Datetime) -> Value

Converts to this type from the input type.
source§

impl<S: Into<String> + Hash + Eq, V: Into<Value>> From<HashMap<S, V>> for Value

source§

fn from(val: HashMap<S, V>) -> Value

Converts to this type from the input type.
source§

impl From<Map<String, Value>> for Value

source§

fn from(val: Table) -> Value

Converts to this type from the input type.
source§

impl From<String> for Value

source§

fn from(val: String) -> Value

Converts to this type from the input type.
source§

impl<V: Into<Value>> From<Vec<V>> for Value

source§

fn from(val: Vec<V>) -> Value

Converts to this type from the input type.
source§

impl From<bool> for Value

source§

fn from(val: bool) -> Value

Converts to this type from the input type.
source§

impl From<f32> for Value

source§

fn from(val: f32) -> Value

Converts to this type from the input type.
source§

impl From<f64> for Value

source§

fn from(val: f64) -> Value

Converts to this type from the input type.
source§

impl From<i32> for Value

source§

fn from(val: i32) -> Value

Converts to this type from the input type.
source§

impl From<i64> for Value

source§

fn from(val: i64) -> Value

Converts to this type from the input type.
source§

impl From<i8> for Value

source§

fn from(val: i8) -> Value

Converts to this type from the input type.
source§

impl From<u32> for Value

source§

fn from(val: u32) -> Value

Converts to this type from the input type.
source§

impl From<u8> for Value

source§

fn from(val: u8) -> Value

Converts to this type from the input type.
source§

impl FromStr for Value

§

type Err = Error

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Value, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl<I> Index<I> for Value
where I: Index,

§

type Output = Value

The returned type after indexing.
source§

fn index(&self, index: I) -> &Value

Performs the indexing (container[index]) operation. Read more
source§

impl<I> IndexMut<I> for Value
where I: Index,

source§

fn index_mut(&mut self, index: I) -> &mut Value

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'de> IntoDeserializer<'de, Error> for Value

§

type Deserializer = Value

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self

Convert this value into a deserializer.
source§

impl PartialEq for Value

source§

fn eq(&self, other: &Value) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always diff --git a/toml/value/struct.Datetime.html b/toml/value/struct.Datetime.html index f9dc92106..736f1ac84 100644 --- a/toml/value/struct.Datetime.html +++ b/toml/value/struct.Datetime.html @@ -62,7 +62,7 @@ Required for: Offset Date-Time.

Trait Implementations§

source§

impl Clone for Datetime

source§

fn clone(&self) -> Datetime

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for Datetime

source§

fn deserialize<D>( deserializer: D ) -> Result<Datetime, <D as Deserializer<'de>>::Error>
where - D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Datetime

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(val: Datetime) -> Value

Converts to this type from the input type.
source§

impl From<Time> for Datetime

source§

fn from(other: Time) -> Datetime

Converts to this type from the input type.
source§

impl FromStr for Datetime

§

type Err = DatetimeParseError

The associated error which can be returned from parsing.
source§

fn from_str(date: &str) -> Result<Datetime, DatetimeParseError>

Parses a string s to return a value of this type. Read more
source§

impl Ord for Datetime

source§

fn cmp(&self, other: &Datetime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where + D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Datetime

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(val: Datetime) -> Value

Converts to this type from the input type.
source§

impl From<Time> for Datetime

source§

fn from(other: Time) -> Datetime

Converts to this type from the input type.
source§

impl FromStr for Datetime

§

type Err = DatetimeParseError

The associated error which can be returned from parsing.
source§

fn from_str(date: &str) -> Result<Datetime, DatetimeParseError>

Parses a string s to return a value of this type. Read more
source§

impl Ord for Datetime

source§

fn cmp(&self, other: &Datetime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Datetime

source§

fn eq(&self, other: &Datetime) -> bool

This method tests for self and other values to be equal, and is used diff --git a/toml_datetime/struct.Date.html b/toml_datetime/struct.Date.html index 47163b465..bbb4bb6b4 100644 --- a/toml_datetime/struct.Date.html +++ b/toml_datetime/struct.Date.html @@ -15,7 +15,7 @@ timezone.

Fields§

§year: u16

Year: four digits

§month: u8

Month: 1 to 12

§day: u8

Day: 1 to {28, 29, 30, 31} (based on month/year)

-

Trait Implementations§

source§

impl Clone for Date

source§

fn clone(&self) -> Date

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Date

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Date

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Self

Converts to this type from the input type.
source§

impl Ord for Date

source§

fn cmp(&self, other: &Date) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where +

Trait Implementations§

source§

impl Clone for Date

source§

fn clone(&self) -> Date

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Date

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Date

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Self

Converts to this type from the input type.
source§

impl Ord for Date

source§

fn cmp(&self, other: &Date) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Date

source§

fn eq(&self, other: &Date) -> bool

This method tests for self and other values to be equal, and is used diff --git a/toml_datetime/struct.Datetime.html b/toml_datetime/struct.Datetime.html index 47900eeb1..733adebda 100644 --- a/toml_datetime/struct.Datetime.html +++ b/toml_datetime/struct.Datetime.html @@ -60,7 +60,7 @@ Required for: Offset Date-Time, Local Date-Time, Local Tim
§offset: Option<Offset>

Optional offset. Required for: Offset Date-Time.

Trait Implementations§

source§

impl Clone for Datetime

source§

fn clone(&self) -> Datetime

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for Datetime

source§

fn deserialize<D>(deserializer: D) -> Result<Datetime, D::Error>
where - D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Self

Converts to this type from the input type.
source§

impl From<Time> for Datetime

source§

fn from(other: Time) -> Self

Converts to this type from the input type.
source§

impl FromStr for Datetime

§

type Err = DatetimeParseError

The associated error which can be returned from parsing.
source§

fn from_str(date: &str) -> Result<Datetime, DatetimeParseError>

Parses a string s to return a value of this type. Read more
source§

impl Ord for Datetime

source§

fn cmp(&self, other: &Datetime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where + D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Self

Converts to this type from the input type.
source§

impl From<Time> for Datetime

source§

fn from(other: Time) -> Self

Converts to this type from the input type.
source§

impl FromStr for Datetime

§

type Err = DatetimeParseError

The associated error which can be returned from parsing.
source§

fn from_str(date: &str) -> Result<Datetime, DatetimeParseError>

Parses a string s to return a value of this type. Read more
source§

impl Ord for Datetime

source§

fn cmp(&self, other: &Datetime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Datetime

source§

fn eq(&self, other: &Datetime) -> bool

This method tests for self and other values to be equal, and is used diff --git a/toml_edit/de/struct.Error.html b/toml_edit/de/struct.Error.html index fea9f3da3..c64ee658f 100644 --- a/toml_edit/de/struct.Error.html +++ b/toml_edit/de/struct.Error.html @@ -3,7 +3,7 @@

Implementations§

source§

impl Error

source

pub fn add_key(&mut self, key: String)

Add key while unwinding

source

pub fn message(&self) -> &str

What went wrong

source

pub fn span(&self) -> Option<Range<usize>>

The start/end index into the original document where the error occurred

-

Trait Implementations§

source§

impl Clone for Error

source§

fn clone(&self) -> Error

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Error

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Error

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where +

Trait Implementations§

source§

impl Clone for Error

source§

fn clone(&self) -> Error

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Error

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Error

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for Error

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where T: Display,

Raised when there is general error when deserializing a type. Read more
source§

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting. Read more
source§

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason. Read more
source§

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains @@ -12,7 +12,7 @@ unrecognized name.
source§

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.
source§

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the -same field.
source§

impl Error for Error

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl<'de> IntoDeserializer<'de, Error> for Deserializer

§

type Deserializer = Deserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for DocumentMut

§

type Deserializer = Deserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for ImDocument<String>

§

type Deserializer = Deserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for Value

§

type Deserializer = ValueDeserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for ValueDeserializer

§

type Deserializer = ValueDeserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl PartialEq for Error

source§

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used +same field.
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl<'de> IntoDeserializer<'de, Error> for Deserializer

§

type Deserializer = Deserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for DocumentMut

§

type Deserializer = Deserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for ImDocument<String>

§

type Deserializer = Deserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for Value

§

type Deserializer = ValueDeserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl<'de> IntoDeserializer<'de, Error> for ValueDeserializer

§

type Deserializer = ValueDeserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.
source§

impl PartialEq for Error

source§

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Error

source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/toml_edit/enum.Value.html b/toml_edit/enum.Value.html index 3d5d9249f..44b324890 100644 --- a/toml_edit/enum.Value.html +++ b/toml_edit/enum.Value.html @@ -53,7 +53,7 @@ assert_eq!(&d.to_string(), " 42 ");

source

pub fn span(&self) -> Option<Range<usize>>

The location within the original document

This generally requires an ImDocument.

-

Trait Implementations§

source§

impl Clone for Value

source§

fn clone(&self) -> Value

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Value

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Value

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'b> From<&'b InternalString> for Value

source§

fn from(s: &'b InternalString) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b String> for Value

source§

fn from(s: &'b String) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b Value> for Value

source§

fn from(s: &'b Value) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b str> for Value

source§

fn from(s: &'b str) -> Self

Converts to this type from the input type.
source§

impl From<Array> for Value

source§

fn from(array: Array) -> Self

Converts to this type from the input type.
source§

impl From<Date> for Value

source§

fn from(d: Date) -> Self

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(d: Datetime) -> Self

Converts to this type from the input type.
source§

impl From<InlineTable> for Value

source§

fn from(table: InlineTable) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Value

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for Value

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl From<Time> for Value

source§

fn from(d: Time) -> Self

Converts to this type from the input type.
source§

impl From<bool> for Value

source§

fn from(b: bool) -> Self

Converts to this type from the input type.
source§

impl From<f64> for Value

source§

fn from(f: f64) -> Self

Converts to this type from the input type.
source§

impl From<i64> for Value

source§

fn from(i: i64) -> Self

Converts to this type from the input type.
source§

impl<K: Into<Key>, V: Into<Value>> FromIterator<(K, V)> for Value

source§

fn from_iter<I>(iter: I) -> Self
where +

Trait Implementations§

source§

impl Clone for Value

source§

fn clone(&self) -> Value

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Value

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Value

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'b> From<&'b InternalString> for Value

source§

fn from(s: &'b InternalString) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b String> for Value

source§

fn from(s: &'b String) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b Value> for Value

source§

fn from(s: &'b Value) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b str> for Value

source§

fn from(s: &'b str) -> Self

Converts to this type from the input type.
source§

impl From<Array> for Value

source§

fn from(array: Array) -> Self

Converts to this type from the input type.
source§

impl From<Date> for Value

source§

fn from(d: Date) -> Self

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(d: Datetime) -> Self

Converts to this type from the input type.
source§

impl From<InlineTable> for Value

source§

fn from(table: InlineTable) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Value

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for Value

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl From<Time> for Value

source§

fn from(d: Time) -> Self

Converts to this type from the input type.
source§

impl From<bool> for Value

source§

fn from(b: bool) -> Self

Converts to this type from the input type.
source§

impl From<f64> for Value

source§

fn from(f: f64) -> Self

Converts to this type from the input type.
source§

impl From<i64> for Value

source§

fn from(i: i64) -> Self

Converts to this type from the input type.
source§

impl<K: Into<Key>, V: Into<Value>> FromIterator<(K, V)> for Value

source§

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
source§

impl<V: Into<Value>> FromIterator<V> for Value

source§

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = V>,

Creates a value from an iterator. Read more
source§

impl FromStr for Value

source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a value from a &str

§

type Err = TomlError

The associated error which can be returned from parsing.
source§

impl<'de> IntoDeserializer<'de, Error> for Value

§

type Deserializer = ValueDeserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

Auto Trait Implementations§

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnwindSafe for Value

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/toml_edit/ser/enum.Error.html b/toml_edit/ser/enum.Error.html index dbbf156ad..004b63e97 100644 --- a/toml_edit/ser/enum.Error.html +++ b/toml_edit/ser/enum.Error.html @@ -13,9 +13,9 @@
§

KeyNotString

Key was not convertible to String for serializing to TOML

§

DateInvalid

A serialized date was invalid

§

Custom(String)

Other serialization error

-

Trait Implementations§

source§

impl Clone for Error

source§

fn clone(&self) -> Error

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Error

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where +

Trait Implementations§

source§

impl Clone for Error

source§

fn clone(&self) -> Error

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Error

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for Error

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for Error

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Error for Error

source§

fn custom<T>(msg: T) -> Self
where T: Display,

Used when a Serialize implementation encounters any error -while serializing a type. Read more
source§

impl Error for Error

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl PartialEq for Error

source§

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used +while serializing a type. Read more
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl PartialEq for Error

source§

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Error

source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/toml_edit/struct.Array.html b/toml_edit/struct.Array.html index 41f45135a..9b74eda9a 100644 --- a/toml_edit/struct.Array.html +++ b/toml_edit/struct.Array.html @@ -119,8 +119,8 @@ total order if it is (for all a, b and c) K: Ord,

Sorts the array with a key extraction function.

This sort is stable (i.e., does not reorder equal elements) and O(m * n * log(n)) worst-case, where the key function is O(m).

-

Trait Implementations§

source§

impl Clone for Array

source§

fn clone(&self) -> Array

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Array

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Array

source§

fn default() -> Array

Returns the “default value” for a type. Read more
source§

impl Display for Array

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<V: Into<Value>> Extend<V> for Array

source§

fn extend<T: IntoIterator<Item = V>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<Array> for Value

source§

fn from(array: Array) -> Self

Converts to this type from the input type.
source§

impl<V: Into<Value>> FromIterator<V> for Array

source§

fn from_iter<I>(iter: I) -> Self
where - I: IntoIterator<Item = V>,

Creates a value from an iterator. Read more
source§

impl<'s> IntoIterator for &'s Array

§

type Item = &'s Value

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = &'s Value> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for Array

§

type Item = Value

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = Value>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl Freeze for Array

§

impl RefUnwindSafe for Array

§

impl Send for Array

§

impl Sync for Array

§

impl Unpin for Array

§

impl UnwindSafe for Array

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl Clone for Array

source§

fn clone(&self) -> Array

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Array

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Array

source§

fn default() -> Array

Returns the “default value” for a type. Read more
source§

impl Display for Array

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<V: Into<Value>> Extend<V> for Array

source§

fn extend<T: IntoIterator<Item = V>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<Array> for Value

source§

fn from(array: Array) -> Self

Converts to this type from the input type.
source§

impl<V: Into<Value>> FromIterator<V> for Array

source§

fn from_iter<I>(iter: I) -> Self
where + I: IntoIterator<Item = V>,

Creates a value from an iterator. Read more
source§

impl<'s> IntoIterator for &'s Array

§

type Item = &'s Value

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = &'s Value> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for Array

§

type Item = Value

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = Value>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl Freeze for Array

§

impl RefUnwindSafe for Array

§

impl Send for Array

§

impl Sync for Array

§

impl Unpin for Array

§

impl UnwindSafe for Array

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/toml_edit/struct.ArrayOfTables.html b/toml_edit/struct.ArrayOfTables.html index 0d2df9fa7..0ee2d2e9a 100644 --- a/toml_edit/struct.ArrayOfTables.html +++ b/toml_edit/struct.ArrayOfTables.html @@ -23,7 +23,7 @@ To get the actual number of items use a.iter().count().

This method operates in place, visiting each element exactly once in the original order, and preserves the order of the retained elements.

Trait Implementations§

source§

impl Clone for ArrayOfTables

source§

fn clone(&self) -> ArrayOfTables

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ArrayOfTables

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for ArrayOfTables

source§

fn default() -> ArrayOfTables

Returns the “default value” for a type. Read more
source§

impl Display for ArrayOfTables

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Extend<Table> for ArrayOfTables

source§

fn extend<T: IntoIterator<Item = Table>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl FromIterator<Table> for ArrayOfTables

source§

fn from_iter<I>(iter: I) -> Self
where - I: IntoIterator<Item = Table>,

Creates a value from an iterator. Read more
source§

impl<'s> IntoIterator for &'s ArrayOfTables

§

type Item = &'s Table

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = &'s Table> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for ArrayOfTables

§

type Item = Table

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = Table>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where + I: IntoIterator<Item = Table>,

Creates a value from an iterator. Read more
source§

impl<'s> IntoIterator for &'s ArrayOfTables

§

type Item = &'s Table

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = &'s Table> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for ArrayOfTables

§

type Item = Table

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = Table>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/toml_edit/struct.Datetime.html b/toml_edit/struct.Datetime.html index 528dca9ed..44ca29bfb 100644 --- a/toml_edit/struct.Datetime.html +++ b/toml_edit/struct.Datetime.html @@ -62,7 +62,7 @@ Required for: Offset Date-Time.

Trait Implementations§

source§

impl Clone for Datetime

source§

fn clone(&self) -> Datetime

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for Datetime

source§

fn deserialize<D>( deserializer: D ) -> Result<Datetime, <D as Deserializer<'de>>::Error>
where - D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Datetime

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(d: Datetime) -> Self

Converts to this type from the input type.
source§

impl From<Time> for Datetime

source§

fn from(other: Time) -> Datetime

Converts to this type from the input type.
source§

impl FromStr for Datetime

§

type Err = DatetimeParseError

The associated error which can be returned from parsing.
source§

fn from_str(date: &str) -> Result<Datetime, DatetimeParseError>

Parses a string s to return a value of this type. Read more
source§

impl Ord for Datetime

source§

fn cmp(&self, other: &Datetime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where + D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Datetime

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl From<Date> for Datetime

source§

fn from(other: Date) -> Datetime

Converts to this type from the input type.
source§

impl From<Datetime> for Value

source§

fn from(d: Datetime) -> Self

Converts to this type from the input type.
source§

impl From<Time> for Datetime

source§

fn from(other: Time) -> Datetime

Converts to this type from the input type.
source§

impl FromStr for Datetime

§

type Err = DatetimeParseError

The associated error which can be returned from parsing.
source§

fn from_str(date: &str) -> Result<Datetime, DatetimeParseError>

Parses a string s to return a value of this type. Read more
source§

impl Ord for Datetime

source§

fn cmp(&self, other: &Datetime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Datetime

source§

fn eq(&self, other: &Datetime) -> bool

This method tests for self and other values to be equal, and is used diff --git a/toml_edit/struct.Formatted.html b/toml_edit/struct.Formatted.html index fd1c33435..2803c75a8 100644 --- a/toml_edit/struct.Formatted.html +++ b/toml_edit/struct.Formatted.html @@ -14,8 +14,8 @@ including surrounding it whitespaces and comments.

source

pub fn decor(&self) -> &Decor

Returns the surrounding whitespace

source

pub fn fmt(&mut self)

Auto formats the value.

Trait Implementations§

source§

impl<T: Clone> Clone for Formatted<T>

source§

fn clone(&self) -> Formatted<T>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<T> Debug for Formatted<T>
where - T: Debug,

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl<T> Display for Formatted<T>
where - T: ValueRepr,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T: Hash> Hash for Formatted<T>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where + T: Debug,

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl<T> Display for Formatted<T>
where + T: ValueRepr,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T: Hash> Hash for Formatted<T>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T: PartialEq> PartialEq for Formatted<T>

source§

fn eq(&self, other: &Formatted<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always diff --git a/toml_edit/struct.InlineTable.html b/toml_edit/struct.InlineTable.html index f1ae16b26..6c8a36745 100644 --- a/toml_edit/struct.InlineTable.html +++ b/toml_edit/struct.InlineTable.html @@ -60,8 +60,8 @@ Returns a mutable reference to the corresponding value.

In other words, remove all pairs (key, value) for which keep(&key, &mut value) returns false.

The elements are visited in iteration order.

-

Trait Implementations§

source§

impl Clone for InlineTable

source§

fn clone(&self) -> InlineTable

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for InlineTable

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for InlineTable

source§

fn default() -> InlineTable

Returns the “default value” for a type. Read more
source§

impl Display for InlineTable

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<K: Into<Key>, V: Into<Value>> Extend<(K, V)> for InlineTable

source§

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<InlineTable> for Value

source§

fn from(table: InlineTable) -> Self

Converts to this type from the input type.
source§

impl<K: Into<Key>, V: Into<Value>> FromIterator<(K, V)> for InlineTable

source§

fn from_iter<I>(iter: I) -> Self
where - I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
source§

impl<'s> Index<&'s str> for InlineTable

§

type Output = Value

The returned type after indexing.
source§

fn index(&self, key: &'s str) -> &Value

Performs the indexing (container[index]) operation. Read more
source§

impl<'s> IndexMut<&'s str> for InlineTable

source§

fn index_mut(&mut self, key: &'s str) -> &mut Value

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'s> IntoIterator for &'s InlineTable

§

type Item = (&'s str, &'s Value)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (&'s str, &'s Value)> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for InlineTable

§

type Item = (InternalString, Value)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (InternalString, Value)>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl TableLike for InlineTable

source§

fn iter(&self) -> Iter<'_>

Returns an iterator over key/value pairs.
source§

fn iter_mut(&mut self) -> IterMut<'_>

Returns an mutable iterator over all key/value pairs, including empty.
source§

fn clear(&mut self)

Clears the table, removing all key-value pairs. Keeps the allocated memory for reuse.
source§

fn entry<'a>(&'a mut self, key: &str) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn entry_format<'a>(&'a mut self, key: &Key) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn get<'s>(&'s self, key: &str) -> Option<&'s Item>

Returns an optional reference to an item given the key.
source§

fn get_mut<'s>(&'s mut self, key: &str) -> Option<&'s mut Item>

Returns an optional mutable reference to an item given the key.
source§

fn get_key_value<'a>(&'a self, key: &str) -> Option<(&'a Key, &'a Item)>

Return references to the key-value pair stored for key, if it is present, else None.
source§

fn get_key_value_mut<'a>( +

Trait Implementations§

source§

impl Clone for InlineTable

source§

fn clone(&self) -> InlineTable

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for InlineTable

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for InlineTable

source§

fn default() -> InlineTable

Returns the “default value” for a type. Read more
source§

impl Display for InlineTable

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<K: Into<Key>, V: Into<Value>> Extend<(K, V)> for InlineTable

source§

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<InlineTable> for Value

source§

fn from(table: InlineTable) -> Self

Converts to this type from the input type.
source§

impl<K: Into<Key>, V: Into<Value>> FromIterator<(K, V)> for InlineTable

source§

fn from_iter<I>(iter: I) -> Self
where + I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
source§

impl<'s> Index<&'s str> for InlineTable

§

type Output = Value

The returned type after indexing.
source§

fn index(&self, key: &'s str) -> &Value

Performs the indexing (container[index]) operation. Read more
source§

impl<'s> IndexMut<&'s str> for InlineTable

source§

fn index_mut(&mut self, key: &'s str) -> &mut Value

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'s> IntoIterator for &'s InlineTable

§

type Item = (&'s str, &'s Value)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (&'s str, &'s Value)> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for InlineTable

§

type Item = (InternalString, Value)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (InternalString, Value)>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl TableLike for InlineTable

source§

fn iter(&self) -> Iter<'_>

Returns an iterator over key/value pairs.
source§

fn iter_mut(&mut self) -> IterMut<'_>

Returns an mutable iterator over all key/value pairs, including empty.
source§

fn clear(&mut self)

Clears the table, removing all key-value pairs. Keeps the allocated memory for reuse.
source§

fn entry<'a>(&'a mut self, key: &str) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn entry_format<'a>(&'a mut self, key: &Key) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn get<'s>(&'s self, key: &str) -> Option<&'s Item>

Returns an optional reference to an item given the key.
source§

fn get_mut<'s>(&'s mut self, key: &str) -> Option<&'s mut Item>

Returns an optional mutable reference to an item given the key.
source§

fn get_key_value<'a>(&'a self, key: &str) -> Option<(&'a Key, &'a Item)>

Return references to the key-value pair stored for key, if it is present, else None.
source§

fn get_key_value_mut<'a>( &'a mut self, key: &str ) -> Option<(KeyMut<'a>, &'a mut Item)>

Return mutable references to the key-value pair stored for key, if it is present, else None.
source§

fn contains_key(&self, key: &str) -> bool

Returns true if the table contains an item with the given key.
source§

fn insert(&mut self, key: &str, value: Item) -> Option<Item>

Inserts a key-value pair into the map.
source§

fn remove(&mut self, key: &str) -> Option<Item>

Removes an item given the key.
source§

fn get_values(&self) -> Vec<(Vec<&Key>, &Value)>

Get key/values for values that are visually children of this table Read more
source§

fn fmt(&mut self)

Auto formats the table.
source§

fn sort_values(&mut self)

Sorts Key/Value Pairs of the table. Read more
source§

fn set_dotted(&mut self, yes: bool)

Change this table’s dotted status
source§

fn is_dotted(&self) -> bool

Check if this is a wrapper for dotted keys, rather than a standard table
source§

fn key(&self, key: &str) -> Option<&Key>

Returns an accessor to a key’s formatting
source§

fn key_mut(&mut self, key: &str) -> Option<KeyMut<'_>>

Returns an accessor to a key’s formatting
source§

fn key_decor_mut(&mut self, key: &str) -> Option<&mut Decor>

👎Deprecated since 0.21.1: Replaced with key_mut
Returns the decor associated with a given key of the table.
source§

fn key_decor(&self, key: &str) -> Option<&Decor>

👎Deprecated since 0.21.1: Replaced with key_mut
Returns the decor associated with a given key of the table.
source§

fn len(&self) -> usize

Returns the number of nonempty items.
source§

fn is_empty(&self) -> bool

Returns true if the table is empty.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/toml_edit/struct.InternalString.html b/toml_edit/struct.InternalString.html index 144248e09..5d033ac5c 100644 --- a/toml_edit/struct.InternalString.html +++ b/toml_edit/struct.InternalString.html @@ -1230,8 +1230,8 @@ but non-ASCII letters are unchanged.

let s = "Grüße, Jürgen ❤";
 
 assert_eq!("grüße, jürgen ❤", s.to_ascii_lowercase());
-

Trait Implementations§

source§

impl AsRef<str> for InternalString

source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Borrow<str> for InternalString

source§

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more
source§

impl Clone for InternalString

source§

fn clone(&self) -> InternalString

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for InternalString

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Default for InternalString

source§

fn default() -> InternalString

Returns the “default value” for a type. Read more
source§

impl Deref for InternalString

§

type Target = str

The resulting type after dereferencing.
source§

fn deref(&self) -> &str

Dereferences the value.
source§

impl<'de> Deserialize<'de> for InternalString

source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where - D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for InternalString

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<&InternalString> for InternalString

source§

fn from(s: &InternalString) -> Self

Converts to this type from the input type.
source§

impl From<&InternalString> for RawString

source§

fn from(s: &InternalString) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b InternalString> for Value

source§

fn from(s: &'b InternalString) -> Self

Converts to this type from the input type.
source§

impl From<&String> for InternalString

source§

fn from(s: &String) -> Self

Converts to this type from the input type.
source§

impl From<&str> for InternalString

source§

fn from(s: &str) -> Self

Converts to this type from the input type.
source§

impl From<Box<str>> for InternalString

source§

fn from(s: Box<str>) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Key

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for RawString

source§

fn from(inner: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Value

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for InternalString

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl FromStr for InternalString

§

type Err = Infallible

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for InternalString

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +

Trait Implementations§

source§

impl AsRef<str> for InternalString

source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Borrow<str> for InternalString

source§

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more
source§

impl Clone for InternalString

source§

fn clone(&self) -> InternalString

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for InternalString

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Default for InternalString

source§

fn default() -> InternalString

Returns the “default value” for a type. Read more
source§

impl Deref for InternalString

§

type Target = str

The resulting type after dereferencing.
source§

fn deref(&self) -> &str

Dereferences the value.
source§

impl<'de> Deserialize<'de> for InternalString

source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where + D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for InternalString

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<&InternalString> for InternalString

source§

fn from(s: &InternalString) -> Self

Converts to this type from the input type.
source§

impl From<&InternalString> for RawString

source§

fn from(s: &InternalString) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b InternalString> for Value

source§

fn from(s: &'b InternalString) -> Self

Converts to this type from the input type.
source§

impl From<&String> for InternalString

source§

fn from(s: &String) -> Self

Converts to this type from the input type.
source§

impl From<&str> for InternalString

source§

fn from(s: &str) -> Self

Converts to this type from the input type.
source§

impl From<Box<str>> for InternalString

source§

fn from(s: Box<str>) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Key

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for RawString

source§

fn from(inner: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Value

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for InternalString

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl FromStr for InternalString

§

type Err = Infallible

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for InternalString

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for InternalString

source§

fn cmp(&self, other: &InternalString) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where diff --git a/toml_edit/struct.Key.html b/toml_edit/struct.Key.html index 0a820d397..f94a57b1e 100644 --- a/toml_edit/struct.Key.html +++ b/toml_edit/struct.Key.html @@ -1267,7 +1267,7 @@ but non-ASCII letters are unchanged.

let s = "Grüße, Jürgen ❤";
 
 assert_eq!("grüße, jürgen ❤", s.to_ascii_lowercase());
-

Trait Implementations§

source§

impl Clone for Key

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Key

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Deref for Key

§

type Target = str

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl Display for Key

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'b> From<&'b String> for Key

source§

fn from(s: &'b String) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b str> for Key

source§

fn from(s: &'b str) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Key

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for Key

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl FromStr for Key

source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Tries to parse a key from a &str, +

Trait Implementations§

source§

impl Clone for Key

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Key

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Deref for Key

§

type Target = str

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl Display for Key

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'b> From<&'b String> for Key

source§

fn from(s: &'b String) -> Self

Converts to this type from the input type.
source§

impl<'b> From<&'b str> for Key

source§

fn from(s: &'b str) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for Key

source§

fn from(s: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for Key

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl FromStr for Key

source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Tries to parse a key from a &str, if fails, tries as basic quoted key (surrounds with “”) and then literal quoted key (surrounds with ‘’)

§

type Err = TomlError

The associated error which can be returned from parsing.
source§

impl Hash for Key

source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where @@ -1275,14 +1275,14 @@ and then literal quoted key (surrounds with ‘’)

Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Key

source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where - Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<'s> PartialEq<&'s str> for Key

source§

fn eq(&self, other: &&str) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<String> for Key

source§

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used + Self: Sized + PartialOrd,
Restrict a value to a certain interval. Read more
source§

impl<'s> PartialEq<&'s str> for Key

source§

fn eq(&self, other: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<str> for Key

source§

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Key

source§

fn eq(&self, other: &Key) -> bool

This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<String> for Key

source§

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<str> for Key

source§

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Key

source§

fn eq(&self, other: &Key) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Key

source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Key

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnwindSafe for Key

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/toml_edit/struct.KeyMut.html b/toml_edit/struct.KeyMut.html index d5054d2be..d5ff209b5 100644 --- a/toml_edit/struct.KeyMut.html +++ b/toml_edit/struct.KeyMut.html @@ -1246,12 +1246,12 @@ but non-ASCII letters are unchanged.

Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<'s> PartialEq<&'s str> for KeyMut<'s>

source§

fn eq(&self, other: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'s> PartialEq<String> for KeyMut<'s>

source§

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'s> PartialEq<String> for KeyMut<'s>

source§

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'s> PartialEq<str> for KeyMut<'s>

source§

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<'k> PartialEq for KeyMut<'k>

source§

fn eq(&self, other: &KeyMut<'k>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
source§

impl<'k> PartialEq for KeyMut<'k>

source§

fn eq(&self, other: &KeyMut<'k>) -> bool

This method tests for self and other values to be equal, and is used +by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'k> PartialOrd for KeyMut<'k>

source§

fn partial_cmp(&self, other: &KeyMut<'k>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<'k> Eq for KeyMut<'k>

source§

impl<'k> StructuralPartialEq for KeyMut<'k>

Auto Trait Implementations§

§

impl<'k> Freeze for KeyMut<'k>

§

impl<'k> RefUnwindSafe for KeyMut<'k>

§

impl<'k> Send for KeyMut<'k>

§

impl<'k> Sync for KeyMut<'k>

§

impl<'k> Unpin for KeyMut<'k>

§

impl<'k> !UnwindSafe for KeyMut<'k>

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/toml_edit/struct.RawString.html b/toml_edit/struct.RawString.html index 01d57c08e..b203d7082 100644 --- a/toml_edit/struct.RawString.html +++ b/toml_edit/struct.RawString.html @@ -4,7 +4,7 @@

This generally requires a DocumentMut.

source

pub fn span(&self) -> Option<Range<usize>>

The location within the original document

This generally requires an ImDocument.

-

Trait Implementations§

source§

impl Clone for RawString

source§

fn clone(&self) -> RawString

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RawString

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Default for RawString

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl From<&InternalString> for RawString

source§

fn from(s: &InternalString) -> Self

Converts to this type from the input type.
source§

impl From<&String> for RawString

source§

fn from(s: &String) -> Self

Converts to this type from the input type.
source§

impl From<&str> for RawString

source§

fn from(s: &str) -> Self

Converts to this type from the input type.
source§

impl From<Box<str>> for RawString

source§

fn from(s: Box<str>) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for RawString

source§

fn from(inner: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for RawString

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl Hash for RawString

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +

Trait Implementations§

source§

impl Clone for RawString

source§

fn clone(&self) -> RawString

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RawString

source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Default for RawString

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl From<&InternalString> for RawString

source§

fn from(s: &InternalString) -> Self

Converts to this type from the input type.
source§

impl From<&String> for RawString

source§

fn from(s: &String) -> Self

Converts to this type from the input type.
source§

impl From<&str> for RawString

source§

fn from(s: &str) -> Self

Converts to this type from the input type.
source§

impl From<Box<str>> for RawString

source§

fn from(s: Box<str>) -> Self

Converts to this type from the input type.
source§

impl From<InternalString> for RawString

source§

fn from(inner: InternalString) -> Self

Converts to this type from the input type.
source§

impl From<String> for RawString

source§

fn from(s: String) -> Self

Converts to this type from the input type.
source§

impl Hash for RawString

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for RawString

source§

fn eq(&self, other: &RawString) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always diff --git a/toml_edit/struct.Table.html b/toml_edit/struct.Table.html index bb9d353d8..386beebef 100644 --- a/toml_edit/struct.Table.html +++ b/toml_edit/struct.Table.html @@ -67,9 +67,9 @@ in which case its position is set automatically. This can be overridden with

In other words, remove all pairs (key, item) for which keep(&key, &mut item) returns false.

The elements are visited in iteration order.

-

Trait Implementations§

source§

impl Clone for Table

source§

fn clone(&self) -> Table

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Table

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Table

source§

fn default() -> Table

Returns the “default value” for a type. Read more
source§

impl Display for Table

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<K: Into<Key>, V: Into<Value>> Extend<(K, V)> for Table

source§

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Extend<Table> for ArrayOfTables

source§

fn extend<T: IntoIterator<Item = Table>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<Table> for DocumentMut

source§

fn from(root: Table) -> Self

Converts to this type from the input type.
source§

impl<K: Into<Key>, V: Into<Value>> FromIterator<(K, V)> for Table

source§

fn from_iter<I>(iter: I) -> Self
where +

Trait Implementations§

source§

impl Clone for Table

source§

fn clone(&self) -> Table

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Table

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Table

source§

fn default() -> Table

Returns the “default value” for a type. Read more
source§

impl Display for Table

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<K: Into<Key>, V: Into<Value>> Extend<(K, V)> for Table

source§

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Extend<Table> for ArrayOfTables

source§

fn extend<T: IntoIterator<Item = Table>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl From<Table> for DocumentMut

source§

fn from(root: Table) -> Self

Converts to this type from the input type.
source§

impl<K: Into<Key>, V: Into<Value>> FromIterator<(K, V)> for Table

source§

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
source§

impl FromIterator<Table> for ArrayOfTables

source§

fn from_iter<I>(iter: I) -> Self
where - I: IntoIterator<Item = Table>,

Creates a value from an iterator. Read more
source§

impl<'s> Index<&'s str> for Table

§

type Output = Item

The returned type after indexing.
source§

fn index(&self, key: &'s str) -> &Item

Performs the indexing (container[index]) operation. Read more
source§

impl<'s> IndexMut<&'s str> for Table

source§

fn index_mut(&mut self, key: &'s str) -> &mut Item

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'s> IntoIterator for &'s Table

§

type Item = (&'s str, &'s Item)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (&'s str, &'s Item)> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for Table

§

type Item = (InternalString, Item)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (InternalString, Item)>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl TableLike for Table

source§

fn iter(&self) -> Iter<'_>

Returns an iterator over key/value pairs.
source§

fn iter_mut(&mut self) -> IterMut<'_>

Returns an mutable iterator over all key/value pairs, including empty.
source§

fn clear(&mut self)

Clears the table, removing all key-value pairs. Keeps the allocated memory for reuse.
source§

fn entry<'a>(&'a mut self, key: &str) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn entry_format<'a>(&'a mut self, key: &Key) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn get<'s>(&'s self, key: &str) -> Option<&'s Item>

Returns an optional reference to an item given the key.
source§

fn get_mut<'s>(&'s mut self, key: &str) -> Option<&'s mut Item>

Returns an optional mutable reference to an item given the key.
source§

fn get_key_value<'a>(&'a self, key: &str) -> Option<(&'a Key, &'a Item)>

Return references to the key-value pair stored for key, if it is present, else None.
source§

fn get_key_value_mut<'a>( + I: IntoIterator<Item = Table>,

Creates a value from an iterator. Read more
source§

impl<'s> Index<&'s str> for Table

§

type Output = Item

The returned type after indexing.
source§

fn index(&self, key: &'s str) -> &Item

Performs the indexing (container[index]) operation. Read more
source§

impl<'s> IndexMut<&'s str> for Table

source§

fn index_mut(&mut self, key: &'s str) -> &mut Item

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'s> IntoIterator for &'s Table

§

type Item = (&'s str, &'s Item)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (&'s str, &'s Item)> + 's>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for Table

§

type Item = (InternalString, Item)

The type of the elements being iterated over.
§

type IntoIter = Box<dyn Iterator<Item = (InternalString, Item)>>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl TableLike for Table

source§

fn iter(&self) -> Iter<'_>

Returns an iterator over key/value pairs.
source§

fn iter_mut(&mut self) -> IterMut<'_>

Returns an mutable iterator over all key/value pairs, including empty.
source§

fn clear(&mut self)

Clears the table, removing all key-value pairs. Keeps the allocated memory for reuse.
source§

fn entry<'a>(&'a mut self, key: &str) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn entry_format<'a>(&'a mut self, key: &Key) -> Entry<'a>

Gets the given key’s corresponding entry in the Table for in-place manipulation.
source§

fn get<'s>(&'s self, key: &str) -> Option<&'s Item>

Returns an optional reference to an item given the key.
source§

fn get_mut<'s>(&'s mut self, key: &str) -> Option<&'s mut Item>

Returns an optional mutable reference to an item given the key.
source§

fn get_key_value<'a>(&'a self, key: &str) -> Option<(&'a Key, &'a Item)>

Return references to the key-value pair stored for key, if it is present, else None.
source§

fn get_key_value_mut<'a>( &'a mut self, key: &str ) -> Option<(KeyMut<'a>, &'a mut Item)>

Return mutable references to the key-value pair stored for key, if it is present, else None.
source§

fn contains_key(&self, key: &str) -> bool

Returns true if the table contains an item with the given key.
source§

fn insert(&mut self, key: &str, value: Item) -> Option<Item>

Inserts a key-value pair into the map.
source§

fn remove(&mut self, key: &str) -> Option<Item>

Removes an item given the key.
source§

fn get_values(&self) -> Vec<(Vec<&Key>, &Value)>

Get key/values for values that are visually children of this table Read more
source§

fn fmt(&mut self)

Auto formats the table.
source§

fn sort_values(&mut self)

Sorts Key/Value Pairs of the table. Read more
source§

fn is_dotted(&self) -> bool

Check if this is a wrapper for dotted keys, rather than a standard table
source§

fn set_dotted(&mut self, yes: bool)

Change this table’s dotted status
source§

fn key(&self, key: &str) -> Option<&Key>

Returns an accessor to a key’s formatting
source§

fn key_mut(&mut self, key: &str) -> Option<KeyMut<'_>>

Returns an accessor to a key’s formatting
source§

fn key_decor_mut(&mut self, key: &str) -> Option<&mut Decor>

👎Deprecated since 0.21.1: Replaced with key_mut
Returns the decor associated with a given key of the table.
source§

fn key_decor(&self, key: &str) -> Option<&Decor>

👎Deprecated since 0.21.1: Replaced with key_mut
Returns the decor associated with a given key of the table.
source§

fn len(&self) -> usize

Returns the number of nonempty items.
source§

fn is_empty(&self) -> bool

Returns true if the table is empty.

Auto Trait Implementations§

§

impl Freeze for Table

§

impl RefUnwindSafe for Table

§

impl Send for Table

§

impl Sync for Table

§

impl Unpin for Table

§

impl UnwindSafe for Table

Blanket Implementations§

source§

impl<T> Any for T
where diff --git a/toml_edit/struct.TomlError.html b/toml_edit/struct.TomlError.html index 76ac7d069..ed3bfc37f 100644 --- a/toml_edit/struct.TomlError.html +++ b/toml_edit/struct.TomlError.html @@ -2,7 +2,7 @@

Struct toml_edit::TomlError

source · 
pub struct TomlError { /* private fields */ }
Expand description

Type representing a TOML parse error

Implementations§

source§

impl TomlError

source

pub fn message(&self) -> &str

What went wrong

source

pub fn span(&self) -> Option<Range<usize>>

The start/end index into the original document where the error occurred

-

Trait Implementations§

source§

impl Clone for TomlError

source§

fn clone(&self) -> TomlError

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for TomlError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TomlError

Displays a TOML parse error

+

Trait Implementations§

source§

impl Clone for TomlError

source§

fn clone(&self) -> TomlError

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for TomlError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TomlError

Displays a TOML parse error

§Example

TOML parse error at line 1, column 10 | @@ -12,7 +12,7 @@ Unexpected a Expected digit While parsing a Time While parsing a Date-Time

-
source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for TomlError

source§

fn description(&self) -> &'static str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl Hash for TomlError

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +
source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source§

impl Error for TomlError

source§

fn description(&self) -> &'static str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<Error> for TomlError

source§

fn from(e: Error) -> TomlError

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl From<TomlError> for Error

source§

fn from(e: TomlError) -> Error

Converts to this type from the input type.
source§

impl Hash for TomlError

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for TomlError

source§

fn eq(&self, other: &TomlError) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always diff --git a/tracing/field/struct.Field.html b/tracing/field/struct.Field.html index b93043f14..0e7fc1535 100644 --- a/tracing/field/struct.Field.html +++ b/tracing/field/struct.Field.html @@ -9,7 +9,7 @@ and use the key for that name for all other accesses.

Implementations§

source§

impl Field

source

pub fn callsite(&self) -> Identifier

Returns an Identifier that uniquely identifies the Callsite which defines this field.

source

pub fn name(&self) -> &'static str

Returns a string representing the name of the field.

-

Trait Implementations§

source§

impl<'a> AsField for &'a Field

source§

fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field>

Attempts to convert &self into a Field with the specified metadata. Read more
source§

impl AsField for Field

source§

fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field>

Attempts to convert &self into a Field with the specified metadata. Read more
source§

impl AsRef<str> for Field

source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for Field

source§

fn clone(&self) -> Field

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Field

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Display for Field

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Hash for Field

source§

fn hash<H>(&self, state: &mut H)
where +

Trait Implementations§

source§

impl<'a> AsField for &'a Field

source§

fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field>

Attempts to convert &self into a Field with the specified metadata. Read more
source§

impl AsField for Field

source§

fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field>

Attempts to convert &self into a Field with the specified metadata. Read more
source§

impl AsRef<str> for Field

source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for Field

source§

fn clone(&self) -> Field

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Field

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Display for Field

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Hash for Field

source§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Field

source§

fn eq(&self, other: &Field) -> bool

This method tests for self and other values to be equal, and is used diff --git a/tracing/span/struct.Span.html b/tracing/span/struct.Span.html index c9460cb45..a5f8c519d 100644 --- a/tracing/span/struct.Span.html +++ b/tracing/span/struct.Span.html @@ -498,7 +498,7 @@ span.follows_from(id);

if this span is enabled, the provided function is called, and the result is returned. If the span is disabled, the function is not called, and this method returns None instead.

-

Trait Implementations§

source§

impl Clone for Span

source§

fn clone(&self) -> Span

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Span

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Span

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a> From<&'a Span> for Option<&'a Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl<'a> From<&'a Span> for Option<Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl From<Span> for Option<Id>

source§

fn from(span: Span) -> Self

Converts to this type from the input type.
source§

impl Hash for Span

source§

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +

Trait Implementations§

source§

impl Clone for Span

source§

fn clone(&self) -> Span

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Span

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Span

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a> From<&'a Span> for Option<&'a Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl<'a> From<&'a Span> for Option<Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl From<Span> for Option<Id>

source§

fn from(span: Span) -> Self

Converts to this type from the input type.
source§

impl Hash for Span

source§

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Span

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always diff --git a/tracing/struct.Span.html b/tracing/struct.Span.html index 470218222..805c972fc 100644 --- a/tracing/struct.Span.html +++ b/tracing/struct.Span.html @@ -498,7 +498,7 @@ span.follows_from(id);

if this span is enabled, the provided function is called, and the result is returned. If the span is disabled, the function is not called, and this method returns None instead.

-

Trait Implementations§

source§

impl Clone for Span

source§

fn clone(&self) -> Span

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Span

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Span

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a> From<&'a Span> for Option<&'a Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl<'a> From<&'a Span> for Option<Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl From<Span> for Option<Id>

source§

fn from(span: Span) -> Self

Converts to this type from the input type.
source§

impl Hash for Span

source§

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where +

Trait Implementations§

source§

impl Clone for Span

source§

fn clone(&self) -> Span

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Span

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for Span

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a> From<&'a Span> for Option<&'a Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl<'a> From<&'a Span> for Option<Id>

source§

fn from(span: &'a Span) -> Self

Converts to this type from the input type.
source§

impl From<Span> for Option<Id>

source§

fn from(span: Span) -> Self

Converts to this type from the input type.
source§

impl Hash for Span

source§

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Span

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always diff --git a/tracing_subscriber/field/debug/struct.Alt.html b/tracing_subscriber/field/debug/struct.Alt.html index d1f852cd7..81bfb148c 100644 --- a/tracing_subscriber/field/debug/struct.Alt.html +++ b/tracing_subscriber/field/debug/struct.Alt.html @@ -7,12 +7,12 @@ using the alternative (:#) formatter.

V: MakeVisitor<T>,
§

type Visitor = Alt<<V as MakeVisitor<T>>::Visitor>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, target: T) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl<V> Visit for Alt<V>
where V: Visit,

source§

fn record_str(&mut self, field: &Field, value: &str)

Visit a string value.

source§

fn record_f64(&mut self, field: &Field, value: f64)

Visit a double-precision floating point value.
source§

fn record_i64(&mut self, field: &Field, value: i64)

Visit a signed 64-bit integer value.
source§

fn record_u64(&mut self, field: &Field, value: u64)

Visit an unsigned 64-bit integer value.
source§

fn record_bool(&mut self, field: &Field, value: bool)

Visit a boolean value.
source§

fn record_debug(&mut self, field: &Field, value: &dyn Debug)

Visit a value implementing fmt::Debug.
source§

fn record_i128(&mut self, field: &Field, value: i128)

Visit a signed 128-bit integer value.
source§

fn record_u128(&mut self, field: &Field, value: u128)

Visit an unsigned 128-bit integer value.
source§

fn record_error(&mut self, field: &Field, value: &(dyn Error + 'static))

Records a type implementing Error.
source§

impl<V> VisitFmt for Alt<V>
where - V: VisitFmt,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the formatter that this visitor writes to.
source§

impl<V, O> VisitOutput<O> for Alt<V>
where + V: VisitFmt,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the formatter that this visitor writes to.
source§

impl<V, O> VisitOutput<O> for Alt<V>
where V: VisitOutput<O>,

source§

fn finish(self) -> O

Completes the visitor, returning any output. Read more
source§

fn visit<R>(self, fields: &R) -> Out
where R: RecordFields, Self: Sized,

Visit a set of fields, and return the output of finishing the visitor once the fields have been visited.
source§

impl<V> VisitWrite for Alt<V>
where - V: VisitWrite,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the writer that this visitor writes to.

Auto Trait Implementations§

§

impl<V> Freeze for Alt<V>
where + V: VisitWrite,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the writer that this visitor writes to.

Auto Trait Implementations§

§

impl<V> Freeze for Alt<V>
where V: Freeze,

§

impl<V> RefUnwindSafe for Alt<V>
where V: RefUnwindSafe,

§

impl<V> Send for Alt<V>
where V: Send,

§

impl<V> Sync for Alt<V>
where diff --git a/tracing_subscriber/field/display/struct.Messages.html b/tracing_subscriber/field/display/struct.Messages.html index 70a1d72a0..f8eeb119e 100644 --- a/tracing_subscriber/field/display/struct.Messages.html +++ b/tracing_subscriber/field/display/struct.Messages.html @@ -7,12 +7,12 @@ that any strings named message are formatted using fmt::Displ V: MakeVisitor<T>,

§

type Visitor = Messages<<V as MakeVisitor<T>>::Visitor>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, target: T) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl<V> Visit for Messages<V>
where V: Visit,

source§

fn record_str(&mut self, field: &Field, value: &str)

Visit a string value.

source§

fn record_f64(&mut self, field: &Field, value: f64)

Visit a double-precision floating point value.
source§

fn record_i64(&mut self, field: &Field, value: i64)

Visit a signed 64-bit integer value.
source§

fn record_u64(&mut self, field: &Field, value: u64)

Visit an unsigned 64-bit integer value.
source§

fn record_bool(&mut self, field: &Field, value: bool)

Visit a boolean value.
source§

fn record_debug(&mut self, field: &Field, value: &dyn Debug)

Visit a value implementing fmt::Debug.
source§

fn record_i128(&mut self, field: &Field, value: i128)

Visit a signed 128-bit integer value.
source§

fn record_u128(&mut self, field: &Field, value: u128)

Visit an unsigned 128-bit integer value.
source§

fn record_error(&mut self, field: &Field, value: &(dyn Error + 'static))

Records a type implementing Error.
source§

impl<V> VisitFmt for Messages<V>
where - V: VisitFmt,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the formatter that this visitor writes to.
source§

impl<V, O> VisitOutput<O> for Messages<V>
where + V: VisitFmt,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the formatter that this visitor writes to.
source§

impl<V, O> VisitOutput<O> for Messages<V>
where V: VisitOutput<O>,

source§

fn finish(self) -> O

Completes the visitor, returning any output. Read more
source§

fn visit<R>(self, fields: &R) -> Out
where R: RecordFields, Self: Sized,

Visit a set of fields, and return the output of finishing the visitor once the fields have been visited.
source§

impl<V> VisitWrite for Messages<V>
where - V: VisitWrite,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the writer that this visitor writes to.

Auto Trait Implementations§

§

impl<V> Freeze for Messages<V>
where + V: VisitWrite,

source§

fn writer(&mut self) -> &mut dyn Write

Returns the writer that this visitor writes to.

Auto Trait Implementations§

§

impl<V> Freeze for Messages<V>
where V: Freeze,

§

impl<V> RefUnwindSafe for Messages<V>
where V: RefUnwindSafe,

§

impl<V> Send for Messages<V>
where V: Send,

§

impl<V> Sync for Messages<V>
where diff --git a/tracing_subscriber/filter/struct.EnvFilter.html b/tracing_subscriber/filter/struct.EnvFilter.html index 0b1a38d5a..e1ad7be60 100644 --- a/tracing_subscriber/filter/struct.EnvFilter.html +++ b/tracing_subscriber/filter/struct.EnvFilter.html @@ -292,7 +292,7 @@ provided field values.

This is equivalent to calling the Layer::on_record or Filter::on_record methods on EnvFilter’s implementations of those traits, but it does not require the trait to be in scope

-

Trait Implementations§

source§

impl Debug for EnvFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for EnvFilter

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Display for EnvFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<S> Filter<S> for EnvFilter

source§

fn enabled(&self, meta: &Metadata<'_>, ctx: &Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the +

Trait Implementations§

source§

impl Debug for EnvFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for EnvFilter

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Display for EnvFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<S> Filter<S> for EnvFilter

source§

fn enabled(&self, meta: &Metadata<'_>, ctx: &Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given Metadata in the current Context, similarly to Subscriber::enabled. Read more
source§

fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest

Returns an Interest indicating whether this layer will always, sometimes, or never be interested in the given Metadata. Read more
source§

fn max_level_hint(&self) -> Option<LevelFilter>

Returns an optional hint of the highest verbosity level that diff --git a/tracing_subscriber/filter/struct.FromEnvError.html b/tracing_subscriber/filter/struct.FromEnvError.html index a11dc0497..d973b8d58 100644 --- a/tracing_subscriber/filter/struct.FromEnvError.html +++ b/tracing_subscriber/filter/struct.FromEnvError.html @@ -1,7 +1,7 @@ FromEnvError in tracing_subscriber::filter - Rust

Struct tracing_subscriber::filter::FromEnvError

source · 
pub struct FromEnvError { /* private fields */ }
Expand description

Indicates that an error occurred while parsing a EnvFilter from an environment variable.

-

Trait Implementations§

source§

impl Debug for FromEnvError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FromEnvError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for FromEnvError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more
source§

impl From<ParseError> for FromEnvError

source§

fn from(p: ParseError) -> Self

Converts to this type from the input type.
source§

impl From<VarError> for FromEnvError

source§

fn from(v: VarError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl Debug for FromEnvError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for FromEnvError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for FromEnvError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more
source§

impl From<ParseError> for FromEnvError

source§

fn from(p: ParseError) -> Self

Converts to this type from the input type.
source§

impl From<VarError> for FromEnvError

source§

fn from(v: VarError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/tracing_subscriber/filter/struct.LevelFilter.html b/tracing_subscriber/filter/struct.LevelFilter.html index 201d3ed6b..6d2c3eba1 100644 --- a/tracing_subscriber/filter/struct.LevelFilter.html +++ b/tracing_subscriber/filter/struct.LevelFilter.html @@ -36,25 +36,25 @@ filter each callsite individually.

LevelFilter can be used for determining if something is disabled, but should not be used for determining if something is enabled.

-

Trait Implementations§

source§

impl AsLog for LevelFilter

§

type Log = LevelFilter

The log type that this type can be converted into.
source§

fn as_log(&self) -> <LevelFilter as AsLog>::Log

Returns the log equivalent of self.
source§

impl Clone for LevelFilter

source§

fn clone(&self) -> LevelFilter

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for LevelFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Display for LevelFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl<S> Filter<S> for LevelFilter

source§

fn enabled(&self, meta: &Metadata<'_>, _: &Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the +

Trait Implementations§

source§

impl AsLog for LevelFilter

§

type Log = LevelFilter

The log type that this type can be converted into.
source§

fn as_log(&self) -> <LevelFilter as AsLog>::Log

Returns the log equivalent of self.
source§

impl Clone for LevelFilter

source§

fn clone(&self) -> LevelFilter

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for LevelFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Display for LevelFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl<S> Filter<S> for LevelFilter

source§

fn enabled(&self, meta: &Metadata<'_>, _: &Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given Metadata in the current Context, similarly to Subscriber::enabled. Read more
source§

fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest

Returns an Interest indicating whether this layer will always, sometimes, or never be interested in the given Metadata. Read more
source§

fn max_level_hint(&self) -> Option<LevelFilter>

Returns an optional hint of the highest verbosity level that -this Filter will enable. Read more
source§

fn event_enabled(&self, event: &Event<'_>, cx: &Context<'_, S>) -> bool

Called before the filtered [Layer]'s [on_event], to determine if on_event` should be called. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a new span was constructed with the given -Attributes and Id. Read more
source§

fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>)

Notifies this filter that a span with the given Id recorded the given -values. Read more
source§

fn on_enter(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was entered. Read more
source§

fn on_exit(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was exited. Read more
source§

fn on_close(&self, id: Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID has been closed. Read more
source§

impl From<Level> for LevelFilter

source§

fn from(level: Level) -> LevelFilter

Converts to this type from the input type.
source§

impl From<LevelFilter> for Directive

source§

fn from(level: LevelFilter) -> Self

Converts to this type from the input type.
source§

impl From<Option<Level>> for LevelFilter

source§

fn from(level: Option<Level>) -> LevelFilter

Converts to this type from the input type.
source§

impl FromStr for LevelFilter

§

type Err = ParseLevelFilterError

The associated error which can be returned from parsing.
source§

fn from_str(from: &str) -> Result<LevelFilter, <LevelFilter as FromStr>::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for LevelFilter

source§

fn hash<__H>(&self, state: &mut __H)
where +this Filter will enable. Read more

source§

fn event_enabled(&self, event: &Event<'_>, cx: &Context<'_, S>) -> bool

Called before the filtered [Layer]'s [on_event], to determine if on_event` should be called. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a new span was constructed with the given +Attributes and Id. Read more
source§

fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>)

Notifies this filter that a span with the given Id recorded the given +values. Read more
source§

fn on_enter(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was entered. Read more
source§

fn on_exit(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was exited. Read more
source§

fn on_close(&self, id: Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID has been closed. Read more
source§

impl From<Level> for LevelFilter

source§

fn from(level: Level) -> LevelFilter

Converts to this type from the input type.
source§

impl From<LevelFilter> for Directive

source§

fn from(level: LevelFilter) -> Self

Converts to this type from the input type.
source§

impl From<Option<Level>> for LevelFilter

source§

fn from(level: Option<Level>) -> LevelFilter

Converts to this type from the input type.
source§

impl FromStr for LevelFilter

§

type Err = ParseLevelFilterError

The associated error which can be returned from parsing.
source§

fn from_str(from: &str) -> Result<LevelFilter, <LevelFilter as FromStr>::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for LevelFilter

source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<S: Subscriber> Layer<S> for LevelFilter

source§

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly -to Subscriber::register_callsite. Read more
source§

fn enabled(&self, metadata: &Metadata<'_>, _: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the +to Subscriber::register_callsite. Read more
source§

fn enabled(&self, metadata: &Metadata<'_>, _: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current Context, similarly to Subscriber::enabled. Read more
source§

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber. Read more
source§

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a -Subscriber. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given -Attributes and Id.
source§

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given +Subscriber. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given +Attributes and Id.
source§

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.
source§

fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it -follows from the span with the ID follows.
source§

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.
source§

fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)

Notifies this layer that an event has occurred.
source§

fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.
source§

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.
source§

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.
source§

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the +follows from the span with the ID follows.
source§

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.
source§

fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)

Notifies this layer that an event has occurred.
source§

fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.
source§

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.
source§

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.
source§

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.
source§

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered diff --git a/tracing_subscriber/filter/struct.ParseError.html b/tracing_subscriber/filter/struct.ParseError.html index cb4f1625d..fa42510e6 100644 --- a/tracing_subscriber/filter/struct.ParseError.html +++ b/tracing_subscriber/filter/struct.ParseError.html @@ -1,6 +1,6 @@ ParseError in tracing_subscriber::filter - Rust

Struct tracing_subscriber::filter::ParseError

source · 
pub struct ParseError { /* private fields */ }
Expand description

Indicates that a string could not be parsed as a filtering directive.

-

Trait Implementations§

source§

impl Debug for ParseError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for ParseError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for ParseError

source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more
source§

impl From<Box<dyn Error + Send + Sync>> for ParseError

source§

fn from(e: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.
source§

impl From<ParseError> for FromEnvError

source§

fn from(p: ParseError) -> Self

Converts to this type from the input type.
source§

impl From<ParseLevelFilterError> for ParseError

source§

fn from(l: ParseError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl Debug for ParseError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for ParseError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for ParseError

source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more
source§

impl From<Box<dyn Error + Send + Sync>> for ParseError

source§

fn from(e: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.
source§

impl From<ParseError> for FromEnvError

source§

fn from(p: ParseError) -> Self

Converts to this type from the input type.
source§

impl From<ParseLevelFilterError> for ParseError

source§

fn from(l: ParseError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/tracing_subscriber/filter/targets/struct.Targets.html b/tracing_subscriber/filter/targets/struct.Targets.html index 38cfbfa2d..79be37cb5 100644 --- a/tracing_subscriber/filter/targets/struct.Targets.html +++ b/tracing_subscriber/filter/targets/struct.Targets.html @@ -237,27 +237,27 @@ macros.

assert!(filter.would_enable("my_crate", &Level::INFO)); assert!(!filter.would_enable("my_crate::interesting_module", &Level::TRACE));
-

Trait Implementations§

source§

impl Clone for Targets

source§

fn clone(&self) -> Targets

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Targets

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Targets

source§

fn default() -> Targets

Returns the “default value” for a type. Read more
source§

impl Display for Targets

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T, L> Extend<(T, L)> for Targets
where +

Trait Implementations§

source§

impl Clone for Targets

source§

fn clone(&self) -> Targets

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Targets

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Targets

source§

fn default() -> Targets

Returns the “default value” for a type. Read more
source§

impl Display for Targets

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T, L> Extend<(T, L)> for Targets
where T: Into<String>, - L: Into<LevelFilter>,

source§

fn extend<I: IntoIterator<Item = (T, L)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one #72631)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one #72631)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl<S> Filter<S> for Targets

source§

fn enabled(&self, metadata: &Metadata<'_>, _: &Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the + L: Into<LevelFilter>,
source§

fn extend<I: IntoIterator<Item = (T, L)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one #72631)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one #72631)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl<S> Filter<S> for Targets

source§

fn enabled(&self, metadata: &Metadata<'_>, _: &Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given Metadata in the current Context, similarly to Subscriber::enabled. Read more
source§

fn callsite_enabled(&self, metadata: &'static Metadata<'static>) -> Interest

Returns an Interest indicating whether this layer will always, sometimes, or never be interested in the given Metadata. Read more
source§

fn max_level_hint(&self) -> Option<LevelFilter>

Returns an optional hint of the highest verbosity level that -this Filter will enable. Read more
source§

fn event_enabled(&self, event: &Event<'_>, cx: &Context<'_, S>) -> bool

Called before the filtered [Layer]'s [on_event], to determine if on_event` should be called. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a new span was constructed with the given -Attributes and Id. Read more
source§

fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>)

Notifies this filter that a span with the given Id recorded the given -values. Read more
source§

fn on_enter(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was entered. Read more
source§

fn on_exit(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was exited. Read more
source§

fn on_close(&self, id: Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID has been closed. Read more
source§

impl<T, L> FromIterator<(T, L)> for Targets
where +this Filter will enable. Read more

source§

fn event_enabled(&self, event: &Event<'_>, cx: &Context<'_, S>) -> bool

Called before the filtered [Layer]'s [on_event], to determine if on_event` should be called. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a new span was constructed with the given +Attributes and Id. Read more
source§

fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>)

Notifies this filter that a span with the given Id recorded the given +values. Read more
source§

fn on_enter(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was entered. Read more
source§

fn on_exit(&self, id: &Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID was exited. Read more
source§

fn on_close(&self, id: Id, ctx: Context<'_, S>)

Notifies this filter that a span with the given ID has been closed. Read more
source§

impl<T, L> FromIterator<(T, L)> for Targets
where T: Into<String>, L: Into<LevelFilter>,

source§

fn from_iter<I: IntoIterator<Item = (T, L)>>(iter: I) -> Self

Creates a value from an iterator. Read more
source§

impl FromStr for Targets

§

type Err = ParseError

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl<'a> IntoIterator for &'a Targets

§

type Item = (&'a str, LevelFilter)

The type of the elements being iterated over.
§

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for Targets

§

type Item = (String, LevelFilter)

The type of the elements being iterated over.
§

type IntoIter = IntoIter

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<S> Layer<S> for Targets
where - S: Subscriber,

source§

fn enabled(&self, metadata: &Metadata<'_>, _: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the + S: Subscriber,
source§

fn enabled(&self, metadata: &Metadata<'_>, _: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current Context, similarly to Subscriber::enabled. Read more
source§

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite. Read more
source§

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber. Read more
source§

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a -Subscriber. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given -Attributes and Id.
source§

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given +Subscriber. Read more
source§

fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given +Attributes and Id.
source§

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.
source§

fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it -follows from the span with the ID follows.
source§

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.
source§

fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)

Notifies this layer that an event has occurred.
source§

fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.
source§

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.
source§

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.
source§

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the +follows from the span with the ID follows.
source§

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.
source§

fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>)

Notifies this layer that an event has occurred.
source§

fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.
source§

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.
source§

fn on_close(&self, _id: Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.
source§

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.
source§

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered diff --git a/tracing_subscriber/fmt/format/struct.FmtSpan.html b/tracing_subscriber/fmt/format/struct.FmtSpan.html index 60e5c2ce9..01875b0e3 100644 --- a/tracing_subscriber/fmt/format/struct.FmtSpan.html +++ b/tracing_subscriber/fmt/format/struct.FmtSpan.html @@ -8,7 +8,7 @@
source

pub const NONE: FmtSpan = _

spans are ignored (this is the default)

source

pub const ACTIVE: FmtSpan = _

one event per enter/exit of a span

source

pub const FULL: FmtSpan = _

events at all points (new, enter, exit, drop)

-

Trait Implementations§

source§

impl BitAnd for FmtSpan

§

type Output = FmtSpan

The resulting type after applying the & operator.
source§

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation. Read more
source§

impl BitAndAssign for FmtSpan

source§

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation. Read more
source§

impl BitOr for FmtSpan

§

type Output = FmtSpan

The resulting type after applying the | operator.
source§

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation. Read more
source§

impl BitOrAssign for FmtSpan

source§

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more
source§

impl BitXor for FmtSpan

§

type Output = FmtSpan

The resulting type after applying the ^ operator.
source§

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation. Read more
source§

impl BitXorAssign for FmtSpan

source§

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation. Read more
source§

impl Clone for FmtSpan

source§

fn clone(&self) -> FmtSpan

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for FmtSpan

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Ord for FmtSpan

source§

fn cmp(&self, other: &FmtSpan) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where +

Trait Implementations§

source§

impl BitAnd for FmtSpan

§

type Output = FmtSpan

The resulting type after applying the & operator.
source§

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation. Read more
source§

impl BitAndAssign for FmtSpan

source§

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation. Read more
source§

impl BitOr for FmtSpan

§

type Output = FmtSpan

The resulting type after applying the | operator.
source§

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation. Read more
source§

impl BitOrAssign for FmtSpan

source§

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more
source§

impl BitXor for FmtSpan

§

type Output = FmtSpan

The resulting type after applying the ^ operator.
source§

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation. Read more
source§

impl BitXorAssign for FmtSpan

source§

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation. Read more
source§

impl Clone for FmtSpan

source§

fn clone(&self) -> FmtSpan

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for FmtSpan

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Ord for FmtSpan

source§

fn cmp(&self, other: &FmtSpan) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for FmtSpan

source§

fn eq(&self, other: &FmtSpan) -> bool

This method tests for self and other values to be equal, and is used diff --git a/tracing_subscriber/fmt/format/struct.Format.html b/tracing_subscriber/fmt/format/struct.Format.html index 31989b455..04745909e 100644 --- a/tracing_subscriber/fmt/format/struct.Format.html +++ b/tracing_subscriber/fmt/format/struct.Format.html @@ -49,7 +49,7 @@ originated is displayed.

Trait Implementations§

source§

impl<F: Clone, T: Clone> Clone for Format<F, T>

source§

fn clone(&self) -> Format<F, T>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<F: Debug, T: Debug> Debug for Format<F, T>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for Format<Full, SystemTime>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<C, N, T> FormatEvent<C, N> for Format<Pretty, T>
where C: Subscriber + for<'a> LookupSpan<'a>, N: for<'a> FormatFields<'a> + 'static, - T: FormatTime,

source§

fn format_event( + T: FormatTime,

source§

fn format_event( &self, ctx: &FmtContext<'_, C, N>, writer: Writer<'_>, @@ -65,7 +65,7 @@ originated is displayed.

) -> Result

Write a log message for Event in Context to the given Writer.
source§

impl<S, N, T> FormatEvent<S, N> for Format<Full, T>
where S: Subscriber + for<'a> LookupSpan<'a>, N: for<'a> FormatFields<'a> + 'static, - T: FormatTime,

source§

fn format_event( + T: FormatTime,

source§

fn format_event( &self, ctx: &FmtContext<'_, S, N>, writer: Writer<'_>, diff --git a/tracing_subscriber/fmt/format/struct.Writer.html b/tracing_subscriber/fmt/format/struct.Writer.html index 7c51c85ac..733deac4d 100644 --- a/tracing_subscriber/fmt/format/struct.Writer.html +++ b/tracing_subscriber/fmt/format/struct.Writer.html @@ -53,8 +53,8 @@ without needing to import the

source

pub fn has_ansi_escapes(&self) -> bool

Returns true if ANSI escape codes may be used to add colors and other formatting when writing to this Writer.

If this returns false, formatters should not emit ANSI escape codes.

-

Trait Implementations§

source§

impl Debug for Writer<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a> MakeVisitor<Writer<'a>> for DefaultFields

§

type Visitor = DefaultVisitor<'a>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, target: Writer<'a>) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl<'a, F> MakeVisitor<Writer<'a>> for FieldFn<F>
where - F: Fn(&mut Writer<'a>, &Field, &dyn Debug) -> Result + Clone,

§

type Visitor = FieldFnVisitor<'a, F>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, writer: Writer<'a>) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl<'a> MakeVisitor<Writer<'a>> for PrettyFields

§

type Visitor = PrettyVisitor<'a>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, target: Writer<'a>) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl Write for Writer<'_>

source§

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write +

Trait Implementations§

source§

impl Debug for Writer<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a> MakeVisitor<Writer<'a>> for DefaultFields

§

type Visitor = DefaultVisitor<'a>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, target: Writer<'a>) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl<'a, F> MakeVisitor<Writer<'a>> for FieldFn<F>
where + F: Fn(&mut Writer<'a>, &Field, &dyn Debug) -> Result + Clone,

§

type Visitor = FieldFnVisitor<'a, F>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, writer: Writer<'a>) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl<'a> MakeVisitor<Writer<'a>> for PrettyFields

§

type Visitor = PrettyVisitor<'a>

The visitor type produced by this MakeVisitor.
source§

fn make_visitor(&self, target: Writer<'a>) -> Self::Visitor

Make a new visitor for the provided target.
source§

impl Write for Writer<'_>

source§

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded. Read more
source§

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded. Read more
source§

fn write_fmt(&mut self, args: Arguments<'_>) -> Result

Glue for usage of the write! macro with implementors of this trait. Read more

Auto Trait Implementations§

§

impl<'writer> Freeze for Writer<'writer>

§

impl<'writer> !RefUnwindSafe for Writer<'writer>

§

impl<'writer> !Send for Writer<'writer>

§

impl<'writer> !Sync for Writer<'writer>

§

impl<'writer> Unpin for Writer<'writer>

§

impl<'writer> !UnwindSafe for Writer<'writer>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where diff --git a/tracing_subscriber/layer/trait.Layer.html b/tracing_subscriber/layer/trait.Layer.html index 7a7a5855f..6084ea5cd 100644 --- a/tracing_subscriber/layer/trait.Layer.html +++ b/tracing_subscriber/layer/trait.Layer.html @@ -347,4 +347,4 @@ struct implementing Layer. Subscriber + for<'a> LookupSpan<'a>, N: for<'writer> FormatFields<'writer> + 'static, E: FormatEvent<S, N> + 'static, - W: for<'writer> MakeWriter<'writer> + 'static,

source§

impl<S: Subscriber> Layer<S> for EnvFilter

source§

impl<S: Subscriber> Layer<S> for LevelFilter

source§

impl<S: Subscriber> Layer<S> for Identity

\ No newline at end of file + W: for<'writer> MakeWriter<'writer> + 'static,
source§

impl<S: Subscriber> Layer<S> for EnvFilter

source§

impl<S: Subscriber> Layer<S> for LevelFilter

source§

impl<S: Subscriber> Layer<S> for Identity

\ No newline at end of file diff --git a/tracing_subscriber/util/struct.TryInitError.html b/tracing_subscriber/util/struct.TryInitError.html index fa59de2a5..017be3003 100644 --- a/tracing_subscriber/util/struct.TryInitError.html +++ b/tracing_subscriber/util/struct.TryInitError.html @@ -1,6 +1,6 @@ TryInitError in tracing_subscriber::util - Rust

Struct tracing_subscriber::util::TryInitError

source · 
pub struct TryInitError { /* private fields */ }
Expand description

Error returned by try_init if a global default subscriber could not be initialized.

-

Trait Implementations§

source§

impl Debug for TryInitError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TryInitError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for TryInitError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl Debug for TryInitError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for TryInitError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for TryInitError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/trait.impl/core/cmp/trait.PartialEq.js b/trait.impl/core/cmp/trait.PartialEq.js index 474826152..4f4d52a30 100644 --- a/trait.impl/core/cmp/trait.PartialEq.js +++ b/trait.impl/core/cmp/trait.PartialEq.js @@ -49,6 +49,6 @@ "unicode_normalization":[["impl PartialEq for IsNormalized"]], "url":[["impl PartialEq for Origin"],["impl PartialEq for ParseError"],["impl PartialEq for SyntaxViolation"],["impl PartialEq for OpaqueOrigin"],["impl PartialEq for Url"],["impl<S, T> PartialEq<Host<T>> for Host<S>
where\n S: PartialEq<T>,
"]], "utf8parse":[["impl PartialEq for Parser"]], -"winnow":[["impl PartialEq for Endianness"],["impl PartialEq for ErrorKind"],["impl PartialEq for Needed"],["impl PartialEq for StrContext"],["impl PartialEq for StrContextValue"],["impl PartialEq for CompareResult"],["impl PartialEq for BStr"],["impl PartialEq for Bytes"],["impl PartialEq for Range"],["impl<'a, 'b> PartialEq<&'a str> for BStr"],["impl<'a, 'b> PartialEq<&'a str> for Bytes"],["impl<'a, 'b> PartialEq<&'a [u8]> for BStr"],["impl<'a, 'b> PartialEq<&'a [u8]> for Bytes"],["impl<'a, 'b> PartialEq<str> for BStr"],["impl<'a, 'b> PartialEq<str> for Bytes"],["impl<'a, 'b> PartialEq<BStr> for &'a str"],["impl<'a, 'b> PartialEq<BStr> for &'a [u8]"],["impl<'a, 'b> PartialEq<BStr> for str"],["impl<'a, 'b> PartialEq<BStr> for [u8]"],["impl<'a, 'b> PartialEq<Bytes> for &'a str"],["impl<'a, 'b> PartialEq<Bytes> for &'a [u8]"],["impl<'a, 'b> PartialEq<Bytes> for str"],["impl<'a, 'b> PartialEq<Bytes> for [u8]"],["impl<'a, 'b> PartialEq<[u8]> for BStr"],["impl<'a, 'b> PartialEq<[u8]> for Bytes"],["impl<C: PartialEq> PartialEq for ContextError<C>"],["impl<E: PartialEq> PartialEq for ErrMode<E>"],["impl<I: PartialEq + Clone> PartialEq for InputError<I>"],["impl<I: PartialEq> PartialEq for Located<I>"],["impl<I: PartialEq> PartialEq for Partial<I>"],["impl<I: PartialEq, E: PartialEq> PartialEq for ParseError<I, E>"],["impl<I: PartialEq, S: PartialEq> PartialEq for Stateful<I, S>"]], +"winnow":[["impl PartialEq for Endianness"],["impl PartialEq for ErrorKind"],["impl PartialEq for Needed"],["impl PartialEq for StrContext"],["impl PartialEq for StrContextValue"],["impl PartialEq for CompareResult"],["impl PartialEq for BStr"],["impl PartialEq for Bytes"],["impl PartialEq for Range"],["impl<'a> PartialEq<&'a str> for BStr"],["impl<'a> PartialEq<&'a str> for Bytes"],["impl<'a> PartialEq<&'a [u8]> for BStr"],["impl<'a> PartialEq<&'a [u8]> for Bytes"],["impl<'a> PartialEq<str> for BStr"],["impl<'a> PartialEq<str> for Bytes"],["impl<'a> PartialEq<BStr> for &'a str"],["impl<'a> PartialEq<BStr> for &'a [u8]"],["impl<'a> PartialEq<BStr> for str"],["impl<'a> PartialEq<BStr> for [u8]"],["impl<'a> PartialEq<Bytes> for &'a str"],["impl<'a> PartialEq<Bytes> for &'a [u8]"],["impl<'a> PartialEq<Bytes> for str"],["impl<'a> PartialEq<Bytes> for [u8]"],["impl<'a> PartialEq<[u8]> for BStr"],["impl<'a> PartialEq<[u8]> for Bytes"],["impl<C: PartialEq> PartialEq for ContextError<C>"],["impl<E: PartialEq> PartialEq for ErrMode<E>"],["impl<I: PartialEq + Clone> PartialEq for InputError<I>"],["impl<I: PartialEq> PartialEq for Located<I>"],["impl<I: PartialEq> PartialEq for Partial<I>"],["impl<I: PartialEq, E: PartialEq> PartialEq for ParseError<I, E>"],["impl<I: PartialEq, S: PartialEq> PartialEq for Stateful<I, S>"]], "yansi":[["impl PartialEq for Attribute"],["impl PartialEq for Color"],["impl PartialEq for Quirk"],["impl PartialEq for Condition"],["impl PartialEq for Style"]] };if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() \ No newline at end of file diff --git a/trait.impl/core/cmp/trait.PartialOrd.js b/trait.impl/core/cmp/trait.PartialOrd.js index d6f025663..6a0a11b33 100644 --- a/trait.impl/core/cmp/trait.PartialOrd.js +++ b/trait.impl/core/cmp/trait.PartialOrd.js @@ -26,6 +26,6 @@ "tracing_subscriber":[["impl PartialOrd for Directive"],["impl PartialOrd for FmtSpan"]], "unicode_bidi":[["impl PartialOrd for Level"]], "url":[["impl PartialOrd for Url"],["impl<S: PartialOrd> PartialOrd for Host<S>"]], -"winnow":[["impl PartialOrd for BStr"],["impl PartialOrd for Bytes"],["impl<'a, 'b> PartialOrd<&'a str> for BStr"],["impl<'a, 'b> PartialOrd<&'a str> for Bytes"],["impl<'a, 'b> PartialOrd<&'a [u8]> for BStr"],["impl<'a, 'b> PartialOrd<&'a [u8]> for Bytes"],["impl<'a, 'b> PartialOrd<str> for BStr"],["impl<'a, 'b> PartialOrd<str> for Bytes"],["impl<'a, 'b> PartialOrd<BStr> for &'a str"],["impl<'a, 'b> PartialOrd<BStr> for &'a [u8]"],["impl<'a, 'b> PartialOrd<BStr> for str"],["impl<'a, 'b> PartialOrd<BStr> for [u8]"],["impl<'a, 'b> PartialOrd<Bytes> for &'a str"],["impl<'a, 'b> PartialOrd<Bytes> for &'a [u8]"],["impl<'a, 'b> PartialOrd<Bytes> for str"],["impl<'a, 'b> PartialOrd<Bytes> for [u8]"],["impl<'a, 'b> PartialOrd<[u8]> for BStr"],["impl<'a, 'b> PartialOrd<[u8]> for Bytes"],["impl<I: PartialOrd> PartialOrd for Located<I>"],["impl<I: PartialOrd> PartialOrd for Partial<I>"]], +"winnow":[["impl PartialOrd for BStr"],["impl PartialOrd for Bytes"],["impl<'a> PartialOrd<&'a str> for BStr"],["impl<'a> PartialOrd<&'a str> for Bytes"],["impl<'a> PartialOrd<&'a [u8]> for BStr"],["impl<'a> PartialOrd<&'a [u8]> for Bytes"],["impl<'a> PartialOrd<str> for BStr"],["impl<'a> PartialOrd<str> for Bytes"],["impl<'a> PartialOrd<BStr> for &'a str"],["impl<'a> PartialOrd<BStr> for &'a [u8]"],["impl<'a> PartialOrd<BStr> for str"],["impl<'a> PartialOrd<BStr> for [u8]"],["impl<'a> PartialOrd<Bytes> for &'a str"],["impl<'a> PartialOrd<Bytes> for &'a [u8]"],["impl<'a> PartialOrd<Bytes> for str"],["impl<'a> PartialOrd<Bytes> for [u8]"],["impl<'a> PartialOrd<[u8]> for BStr"],["impl<'a> PartialOrd<[u8]> for Bytes"],["impl<I: PartialOrd> PartialOrd for Located<I>"],["impl<I: PartialOrd> PartialOrd for Partial<I>"]], "yansi":[["impl PartialOrd for Attribute"],["impl PartialOrd for Color"],["impl PartialOrd for Quirk"],["impl PartialOrd for Condition"],["impl PartialOrd for Style"]] };if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() \ No newline at end of file diff --git a/type.impl/alloc/vec/struct.Vec.js b/type.impl/alloc/vec/struct.Vec.js index 08621965e..5702dacf8 100644 --- a/type.impl/alloc/vec/struct.Vec.js +++ b/type.impl/alloc/vec/struct.Vec.js @@ -1,3 +1,3 @@ (function() {var type_impls = { -"toml":[["
source§

impl<'i, T> Accumulate<&'i [T]> for Vec<T>
where\n T: Clone,

source§

fn initial(capacity: Option<usize>) -> Vec<T>

Create a new Extend of the correct type
source§

fn accumulate(&mut self, acc: &'i [T])

Accumulate the input into an accumulator
","Accumulate<&'i [T]>","toml::value::Array"],["
source§

impl<T> Accumulate<T> for Vec<T>

source§

fn initial(capacity: Option<usize>) -> Vec<T>

Create a new Extend of the correct type
source§

fn accumulate(&mut self, acc: T)

Accumulate the input into an accumulator
","Accumulate","toml::value::Array"],["
1.5.0 · source§

impl<T, A> AsMut<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.
","AsMut<[T]>","toml::value::Array"],["
1.5.0 · source§

impl<T, A> AsMut<Vec<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn as_mut(&mut self) -> &mut Vec<T, A>

Converts this type into a mutable reference of the (usually inferred) input type.
","AsMut>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> AsRef<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.
","AsRef<[T]>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> AsRef<Vec<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn as_ref(&self) -> &Vec<T, A>

Converts this type into a shared reference of the (usually inferred) input type.
","AsRef>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Borrow<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn borrow(&self) -> &[T]

Immutably borrows from an owned value. Read more
","Borrow<[T]>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> BorrowMut<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn borrow_mut(&mut self) -> &mut [T]

Mutably borrows from an owned value. Read more
","BorrowMut<[T]>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Clone for Vec<T, A>
where\n T: Clone,\n A: Allocator + Clone,

source§

fn clone(&self) -> Vec<T, A>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, other: &Vec<T, A>)

Performs copy-assignment from source. Read more
","Clone","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Debug for Vec<T, A>
where\n T: Debug,\n A: Allocator,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","toml::value::Array"],["
1.0.0 · source§

impl<T> Default for Vec<T>

source§

fn default() -> Vec<T>

Creates an empty Vec<T>.

\n

The vector will not allocate until elements are pushed onto it.

\n
","Default","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Deref for Vec<T, A>
where\n A: Allocator,

§

type Target = [T]

The resulting type after dereferencing.
source§

fn deref(&self) -> &[T]

Dereferences the value.
","Deref","toml::value::Array"],["
1.0.0 · source§

impl<T, A> DerefMut for Vec<T, A>
where\n A: Allocator,

source§

fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.
","DerefMut","toml::value::Array"],["
source§

impl<'de, T> Deserialize<'de> for Vec<T>
where\n T: Deserialize<'de>,

source§

fn deserialize<D>(\n deserializer: D\n) -> Result<Vec<T>, <D as Deserializer<'de>>::Error>
where\n D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
","Deserialize<'de>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Drop for Vec<T, A>
where\n A: Allocator,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
","Drop","toml::value::Array"],["
1.2.0 · source§

impl<'a, T, A> Extend<&'a T> for Vec<T, A>
where\n T: Copy + 'a,\n A: Allocator,

Extend implementation that copies elements out of references before pushing them onto the Vec.

\n

This implementation is specialized for slice iterators, where it uses copy_from_slice to\nappend the entire slice at once.

\n
source§

fn extend<I>(&mut self, iter: I)
where\n I: IntoIterator<Item = &'a T>,

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, _: &'a T)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
","Extend<&'a T>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Extend<T> for Vec<T, A>
where\n A: Allocator,

source§

fn extend<I>(&mut self, iter: I)
where\n I: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
","Extend","toml::value::Array"],["
1.0.0 · source§

impl<T> From<&[T]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &[T]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&[1, 2, 3][..]), vec![1, 2, 3]);
\n
","From<&[T]>","toml::value::Array"],["
1.74.0 · source§

impl<T, const N: usize> From<&[T; N]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &[T; N]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&[1, 2, 3]), vec![1, 2, 3]);
\n
","From<&[T; N]>","toml::value::Array"],["
1.19.0 · source§

impl<T> From<&mut [T]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &mut [T]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&mut [1, 2, 3][..]), vec![1, 2, 3]);
\n
","From<&mut [T]>","toml::value::Array"],["
1.74.0 · source§

impl<T, const N: usize> From<&mut [T; N]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &mut [T; N]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&mut [1, 2, 3]), vec![1, 2, 3]);
\n
","From<&mut [T; N]>","toml::value::Array"],["
1.44.0 · source§

impl<T, const N: usize> From<[T; N]> for Vec<T>

source§

fn from(s: [T; N]) -> Vec<T>

Allocate a Vec<T> and move s’s items into it.

\n
§Examples
\n
assert_eq!(Vec::from([1, 2, 3]), vec![1, 2, 3]);
\n
","From<[T; N]>","toml::value::Array"],["
1.5.0 · source§

impl<T, A> From<BinaryHeap<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn from(heap: BinaryHeap<T, A>) -> Vec<T, A>

Converts a BinaryHeap<T> into a Vec<T>.

\n

This conversion requires no data movement or allocation, and has\nconstant time complexity.

\n
","From>","toml::value::Array"],["
1.18.0 · source§

impl<T, A> From<Box<[T], A>> for Vec<T, A>
where\n A: Allocator,

source§

fn from(s: Box<[T], A>) -> Vec<T, A>

Convert a boxed slice into a vector by transferring ownership of\nthe existing heap allocation.

\n
§Examples
\n
let b: Box<[i32]> = vec![1, 2, 3].into_boxed_slice();\nassert_eq!(Vec::from(b), vec![1, 2, 3]);
\n
","From>","toml::value::Array"],["
1.14.0 · source§

impl<'a, T> From<Cow<'a, [T]>> for Vec<T>
where\n [T]: ToOwned<Owned = Vec<T>>,

source§

fn from(s: Cow<'a, [T]>) -> Vec<T>

Convert a clone-on-write slice into a vector.

\n

If s already owns a Vec<T>, it will be returned directly.\nIf s is borrowing a slice, a new Vec<T> will be allocated and\nfilled by cloning s’s items into it.

\n
§Examples
\n
let o: Cow<'_, [i32]> = Cow::Owned(vec![1, 2, 3]);\nlet b: Cow<'_, [i32]> = Cow::Borrowed(&[1, 2, 3]);\nassert_eq!(Vec::from(o), Vec::from(b));
\n
","From>","toml::value::Array"],["
1.10.0 · source§

impl<T, A> From<VecDeque<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn from(other: VecDeque<T, A>) -> Vec<T, A>

Turn a VecDeque<T> into a Vec<T>.

\n

This never needs to re-allocate, but does need to do O(n) data movement if\nthe circular buffer doesn’t happen to be at the beginning of the allocation.

\n
§Examples
\n
use std::collections::VecDeque;\n\n// This one is *O*(1).\nlet deque: VecDeque<_> = (1..5).collect();\nlet ptr = deque.as_slices().0.as_ptr();\nlet vec = Vec::from(deque);\nassert_eq!(vec, [1, 2, 3, 4]);\nassert_eq!(vec.as_ptr(), ptr);\n\n// This one needs data rearranging.\nlet mut deque: VecDeque<_> = (1..5).collect();\ndeque.push_front(9);\ndeque.push_front(8);\nlet ptr = deque.as_slices().1.as_ptr();\nlet vec = Vec::from(deque);\nassert_eq!(vec, [8, 9, 1, 2, 3, 4]);\nassert_eq!(vec.as_ptr(), ptr);
\n
","From>","toml::value::Array"],["
1.0.0 · source§

impl<T> FromIterator<T> for Vec<T>

Collects an iterator into a Vec, commonly called via Iterator::collect()

\n

§Allocation behavior

\n

In general Vec does not guarantee any particular growth or allocation strategy.\nThat also applies to this trait impl.

\n

Note: This section covers implementation details and is therefore exempt from\nstability guarantees.

\n

Vec may use any or none of the following strategies,\ndepending on the supplied iterator:

\n
    \n
  • preallocate based on Iterator::size_hint()\n
      \n
    • and panic if the number of items is outside the provided lower/upper bounds
      • \n
    \n
    • \n
  • use an amortized growth strategy similar to pushing one item at a time
    • \n
  • perform the iteration in-place on the original allocation backing the iterator
    • \n
\n

The last case warrants some attention. It is an optimization that in many cases reduces peak memory\nconsumption and improves cache locality. But when big, short-lived allocations are created,\nonly a small fraction of their items get collected, no further use is made of the spare capacity\nand the resulting Vec is moved into a longer-lived structure, then this can lead to the large\nallocations having their lifetimes unnecessarily extended which can result in increased memory\nfootprint.

\n

In cases where this is an issue, the excess capacity can be discarded with Vec::shrink_to(),\nVec::shrink_to_fit() or by collecting into Box<[T]> instead, which additionally reduces\nthe size of the long-lived struct.

\n\n
static LONG_LIVED: Mutex<Vec<Vec<u16>>> = Mutex::new(Vec::new());\n\nfor i in 0..10 {\n    let big_temporary: Vec<u16> = (0..1024).collect();\n    // discard most items\n    let mut result: Vec<_> = big_temporary.into_iter().filter(|i| i % 100 == 0).collect();\n    // without this a lot of unused capacity might be moved into the global\n    result.shrink_to_fit();\n    LONG_LIVED.lock().unwrap().push(result);\n}
\n
source§

fn from_iter<I>(iter: I) -> Vec<T>
where\n I: IntoIterator<Item = T>,

Creates a value from an iterator. Read more
","FromIterator","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Hash for Vec<T, A>
where\n T: Hash,\n A: Allocator,

The hash of a vector is the same as that of the corresponding slice,\nas required by the core::borrow::Borrow implementation.

\n\n
use std::hash::BuildHasher;\n\nlet b = std::hash::RandomState::new();\nlet v: Vec<u8> = vec![0xa8, 0x3c, 0x09];\nlet s: &[u8] = &[0xa8, 0x3c, 0x09];\nassert_eq!(b.hash_one(v), b.hash_one(s));
\n
source§

fn hash<H>(&self, state: &mut H)
where\n H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","toml::value::Array"],["
1.0.0 · source§

impl<T, I, A> Index<I> for Vec<T, A>
where\n I: SliceIndex<[T]>,\n A: Allocator,

§

type Output = <I as SliceIndex<[T]>>::Output

The returned type after indexing.
source§

fn index(&self, index: I) -> &<Vec<T, A> as Index<I>>::Output ⓘ

Performs the indexing (container[index]) operation. Read more
","Index","toml::value::Array"],["
1.0.0 · source§

impl<T, I, A> IndexMut<I> for Vec<T, A>
where\n I: SliceIndex<[T]>,\n A: Allocator,

source§

fn index_mut(&mut self, index: I) -> &mut <Vec<T, A> as Index<I>>::Output ⓘ

Performs the mutable indexing (container[index]) operation. Read more
","IndexMut","toml::value::Array"],["
source§

impl<'de, T, E> IntoDeserializer<'de, E> for Vec<T>
where\n T: IntoDeserializer<'de, E>,\n E: Error,

§

type Deserializer = SeqDeserializer<<Vec<T> as IntoIterator>::IntoIter, E>

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> <Vec<T> as IntoDeserializer<'de, E>>::Deserializer ⓘ

Convert this value into a deserializer.
","IntoDeserializer<'de, E>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> IntoIterator for Vec<T, A>
where\n A: Allocator,

source§

fn into_iter(self) -> <Vec<T, A> as IntoIterator>::IntoIter ⓘ

Creates a consuming iterator, that is, one that moves each value out of\nthe vector (from start to end). The vector cannot be used after calling\nthis.

\n
§Examples
\n
let v = vec![\"a\".to_string(), \"b\".to_string()];\nlet mut v_iter = v.into_iter();\n\nlet first_element: Option<String> = v_iter.next();\n\nassert_eq!(first_element, Some(\"a\".to_string()));\nassert_eq!(v_iter.next(), Some(\"b\".to_string()));\nassert_eq!(v_iter.next(), None);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T, A>

Which kind of iterator are we turning this into?
","IntoIterator","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Ord for Vec<T, A>
where\n T: Ord,\n A: Allocator,

Implements ordering of vectors, lexicographically.

\n
source§

fn cmp(&self, other: &Vec<T, A>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A> PartialEq<&[U]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &&[U]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &&[U]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<&[U]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A, const N: usize> PartialEq<&[U; N]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &&[U; N]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &&[U; N]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<&[U; N]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A> PartialEq<&mut [U]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &&mut [U]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &&mut [U]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<&mut [U]>","toml::value::Array"],["
1.48.0 · source§

impl<T, U, A> PartialEq<[U]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &[U]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &[U]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<[U]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A, const N: usize> PartialEq<[U; N]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &[U; N]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &[U; N]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<[U; N]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A1, A2> PartialEq<Vec<U, A2>> for Vec<T, A1>
where\n A1: Allocator,\n A2: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &Vec<U, A2>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &Vec<U, A2>) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq>","toml::value::Array"],["
1.0.0 · source§

impl<T, A1, A2> PartialOrd<Vec<T, A2>> for Vec<T, A1>
where\n T: PartialOrd,\n A1: Allocator,\n A2: Allocator,

Implements comparison of vectors, lexicographically.

\n
source§

fn partial_cmp(&self, other: &Vec<T, A2>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd>","toml::value::Array"],["
source§

impl<T> Serialize for Vec<T>
where\n T: Serialize,

source§

fn serialize<S>(\n &self,\n serializer: S\n) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where\n S: Serializer,

Serialize this value into the given Serde serializer. Read more
","Serialize","toml::value::Array"],["
source§

impl<T> Vec<T>

1.0.0 (const: 1.39.0) · source

pub const fn new() -> Vec<T>

Constructs a new, empty Vec<T>.

\n

The vector will not allocate until elements are pushed onto it.

\n
§Examples
\n
let mut vec: Vec<i32> = Vec::new();
\n
1.0.0 · source

pub fn with_capacity(capacity: usize) -> Vec<T>

Constructs a new, empty Vec<T> with at least the specified capacity.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n

It is important to note that although the returned vector has the\nminimum capacity specified, the vector will have a zero length. For\nan explanation of the difference between length and capacity, see\nCapacity and reallocation.

\n

If it is important to know the exact allocated capacity of a Vec,\nalways use the capacity method after construction.

\n

For Vec<T> where T is a zero-sized type, there will be no allocation\nand the capacity will always be usize::MAX.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = Vec::with_capacity(10);\n\n// The vector contains no items, even though it has capacity for more\nassert_eq!(vec.len(), 0);\nassert!(vec.capacity() >= 10);\n\n// These are all done without reallocating...\nfor i in 0..10 {\n    vec.push(i);\n}\nassert_eq!(vec.len(), 10);\nassert!(vec.capacity() >= 10);\n\n// ...but this may make the vector reallocate\nvec.push(11);\nassert_eq!(vec.len(), 11);\nassert!(vec.capacity() >= 11);\n\n// A vector of a zero-sized type will always over-allocate, since no\n// allocation is necessary\nlet vec_units = Vec::<()>::with_capacity(10);\nassert_eq!(vec_units.capacity(), usize::MAX);
\n
source

pub fn try_with_capacity(capacity: usize) -> Result<Vec<T>, TryReserveError>

🔬This is a nightly-only experimental API. (try_with_capacity)

Constructs a new, empty Vec<T> with at least the specified capacity.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n
§Errors
\n

Returns an error if the capacity exceeds isize::MAX bytes,\nor if the allocator reports allocation failure.

\n
1.0.0 · source

pub unsafe fn from_raw_parts(\n ptr: *mut T,\n length: usize,\n capacity: usize\n) -> Vec<T>

Creates a Vec<T> directly from a pointer, a length, and a capacity.

\n
§Safety
\n

This is highly unsafe, due to the number of invariants that aren’t\nchecked:

\n
    \n
  • ptr must have been allocated using the global allocator, such as via\nthe alloc::alloc function.
    • \n
  • T needs to have the same alignment as what ptr was allocated with.\n(T having a less strict alignment is not sufficient, the alignment really\nneeds to be equal to satisfy the dealloc requirement that memory must be\nallocated and deallocated with the same layout.)
    • \n
  • The size of T times the capacity (ie. the allocated size in bytes) needs\nto be the same size as the pointer was allocated with. (Because similar to\nalignment, dealloc must be called with the same layout size.)
    • \n
  • length needs to be less than or equal to capacity.
    • \n
  • The first length values must be properly initialized values of type T.
    • \n
  • capacity needs to be the capacity that the pointer was allocated with.
    • \n
  • The allocated size in bytes must be no larger than isize::MAX.\nSee the safety documentation of pointer::offset.
    • \n
\n

These requirements are always upheld by any ptr that has been allocated\nvia Vec<T>. Other allocation sources are allowed if the invariants are\nupheld.

\n

Violating these may cause problems like corrupting the allocator’s\ninternal data structures. For example it is normally not safe\nto build a Vec<u8> from a pointer to a C char array with length\nsize_t, doing so is only safe if the array was initially allocated by\na Vec or String.\nIt’s also not safe to build one from a Vec<u16> and its length, because\nthe allocator cares about the alignment, and these two types have different\nalignments. The buffer was allocated with alignment 2 (for u16), but after\nturning it into a Vec<u8> it’ll be deallocated with alignment 1. To avoid\nthese issues, it is often preferable to do casting/transmuting using\nslice::from_raw_parts instead.

\n

The ownership of ptr is effectively transferred to the\nVec<T> which may then deallocate, reallocate or change the\ncontents of memory pointed to by the pointer at will. Ensure\nthat nothing else uses the pointer after calling this\nfunction.

\n
§Examples
\n
use std::ptr;\nuse std::mem;\n\nlet v = vec![1, 2, 3];\n\n// Prevent running `v`'s destructor so we are in complete control\n// of the allocation.\nlet mut v = mem::ManuallyDrop::new(v);\n\n// Pull out the various important pieces of information about `v`\nlet p = v.as_mut_ptr();\nlet len = v.len();\nlet cap = v.capacity();\n\nunsafe {\n    // Overwrite memory with 4, 5, 6\n    for i in 0..len {\n        ptr::write(p.add(i), 4 + i);\n    }\n\n    // Put everything back together into a Vec\n    let rebuilt = Vec::from_raw_parts(p, len, cap);\n    assert_eq!(rebuilt, [4, 5, 6]);\n}
\n

Using memory that was allocated elsewhere:

\n\n
use std::alloc::{alloc, Layout};\n\nfn main() {\n    let layout = Layout::array::<u32>(16).expect(\"overflow cannot happen\");\n\n    let vec = unsafe {\n        let mem = alloc(layout).cast::<u32>();\n        if mem.is_null() {\n            return;\n        }\n\n        mem.write(1_000_000);\n\n        Vec::from_raw_parts(mem, 1, 16)\n    };\n\n    assert_eq!(vec, &[1_000_000]);\n    assert_eq!(vec.capacity(), 16);\n}
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n T: Clone,\n A: Allocator,

1.5.0 · source

pub fn resize(&mut self, new_len: usize, value: T)

Resizes the Vec in-place so that len is equal to new_len.

\n

If new_len is greater than len, the Vec is extended by the\ndifference, with each additional slot filled with value.\nIf new_len is less than len, the Vec is simply truncated.

\n

This method requires T to implement Clone,\nin order to be able to clone the passed value.\nIf you need more flexibility (or want to rely on Default instead of\nClone), use Vec::resize_with.\nIf you only need to resize to a smaller size, use Vec::truncate.

\n
§Examples
\n
let mut vec = vec![\"hello\"];\nvec.resize(3, \"world\");\nassert_eq!(vec, [\"hello\", \"world\", \"world\"]);\n\nlet mut vec = vec![1, 2, 3, 4];\nvec.resize(2, 0);\nassert_eq!(vec, [1, 2]);
\n
1.6.0 · source

pub fn extend_from_slice(&mut self, other: &[T])

Clones and appends all elements in a slice to the Vec.

\n

Iterates over the slice other, clones each element, and then appends\nit to this Vec. The other slice is traversed in-order.

\n

Note that this function is same as extend except that it is\nspecialized to work with slices instead. If and when Rust gets\nspecialization this function will likely be deprecated (but still\navailable).

\n
§Examples
\n
let mut vec = vec![1];\nvec.extend_from_slice(&[2, 3, 4]);\nassert_eq!(vec, [1, 2, 3, 4]);
\n
1.53.0 · source

pub fn extend_from_within<R>(&mut self, src: R)
where\n R: RangeBounds<usize>,

Copies elements from src range to the end of the vector.

\n
§Panics
\n

Panics if the starting point is greater than the end point or if\nthe end point is greater than the length of the vector.

\n
§Examples
\n
let mut vec = vec![0, 1, 2, 3, 4];\n\nvec.extend_from_within(2..);\nassert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4]);\n\nvec.extend_from_within(..2);\nassert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1]);\n\nvec.extend_from_within(4..8);\nassert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1, 4, 2, 3, 4]);
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n T: PartialEq,\n A: Allocator,

1.0.0 · source

pub fn dedup(&mut self)

Removes consecutive repeated elements in the vector according to the\nPartialEq trait implementation.

\n

If the vector is sorted, this removes all duplicates.

\n
§Examples
\n
let mut vec = vec![1, 2, 2, 3, 2];\n\nvec.dedup();\n\nassert_eq!(vec, [1, 2, 3, 2]);
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n A: Allocator,

1.21.0 · source

pub fn splice<R, I>(\n &mut self,\n range: R,\n replace_with: I\n) -> Splice<'_, <I as IntoIterator>::IntoIter, A>
where\n R: RangeBounds<usize>,\n I: IntoIterator<Item = T>,

Creates a splicing iterator that replaces the specified range in the vector\nwith the given replace_with iterator and yields the removed items.\nreplace_with does not need to be the same length as range.

\n

range is removed even if the iterator is not consumed until the end.

\n

It is unspecified how many elements are removed from the vector\nif the Splice value is leaked.

\n

The input iterator replace_with is only consumed when the Splice value is dropped.

\n

This is optimal if:

\n
    \n
  • The tail (elements in the vector after range) is empty,
    • \n
  • or replace_with yields fewer or equal elements than range’s length
    • \n
  • or the lower bound of its size_hint() is exact.
    • \n
\n

Otherwise, a temporary vector is allocated and the tail is moved twice.

\n
§Panics
\n

Panics if the starting point is greater than the end point or if\nthe end point is greater than the length of the vector.

\n
§Examples
\n
let mut v = vec![1, 2, 3, 4];\nlet new = [7, 8, 9];\nlet u: Vec<_> = v.splice(1..3, new).collect();\nassert_eq!(v, &[1, 7, 8, 9, 4]);\nassert_eq!(u, &[2, 3]);
\n
source

pub fn extract_if<F>(&mut self, filter: F) -> ExtractIf<'_, T, F, A>
where\n F: FnMut(&mut T) -> bool,

🔬This is a nightly-only experimental API. (extract_if)

Creates an iterator which uses a closure to determine if an element should be removed.

\n

If the closure returns true, then the element is removed and yielded.\nIf the closure returns false, the element will remain in the vector and will not be yielded\nby the iterator.

\n

If the returned ExtractIf is not exhausted, e.g. because it is dropped without iterating\nor the iteration short-circuits, then the remaining elements will be retained.\nUse retain with a negated predicate if you do not need the returned iterator.

\n

Using this method is equivalent to the following code:

\n\n
let mut i = 0;\nwhile i < vec.len() {\n    if some_predicate(&mut vec[i]) {\n        let val = vec.remove(i);\n        // your code here\n    } else {\n        i += 1;\n    }\n}\n
\n

But extract_if is easier to use. extract_if is also more efficient,\nbecause it can backshift the elements of the array in bulk.

\n

Note that extract_if also lets you mutate every element in the filter closure,\nregardless of whether you choose to keep or remove it.

\n
§Examples
\n

Splitting an array into evens and odds, reusing the original allocation:

\n\n
#![feature(extract_if)]\nlet mut numbers = vec![1, 2, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15];\n\nlet evens = numbers.extract_if(|x| *x % 2 == 0).collect::<Vec<_>>();\nlet odds = numbers;\n\nassert_eq!(evens, vec![2, 4, 6, 8, 14]);\nassert_eq!(odds, vec![1, 3, 5, 9, 11, 13, 15]);
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n A: Allocator,

source

pub const fn new_in(alloc: A) -> Vec<T, A>

🔬This is a nightly-only experimental API. (allocator_api)

Constructs a new, empty Vec<T, A>.

\n

The vector will not allocate until elements are pushed onto it.

\n
§Examples
\n
#![feature(allocator_api)]\n\nuse std::alloc::System;\n\nlet mut vec: Vec<i32, _> = Vec::new_in(System);
\n
source

pub fn with_capacity_in(capacity: usize, alloc: A) -> Vec<T, A>

🔬This is a nightly-only experimental API. (allocator_api)

Constructs a new, empty Vec<T, A> with at least the specified capacity\nwith the provided allocator.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n

It is important to note that although the returned vector has the\nminimum capacity specified, the vector will have a zero length. For\nan explanation of the difference between length and capacity, see\nCapacity and reallocation.

\n

If it is important to know the exact allocated capacity of a Vec,\nalways use the capacity method after construction.

\n

For Vec<T, A> where T is a zero-sized type, there will be no allocation\nand the capacity will always be usize::MAX.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
#![feature(allocator_api)]\n\nuse std::alloc::System;\n\nlet mut vec = Vec::with_capacity_in(10, System);\n\n// The vector contains no items, even though it has capacity for more\nassert_eq!(vec.len(), 0);\nassert!(vec.capacity() >= 10);\n\n// These are all done without reallocating...\nfor i in 0..10 {\n    vec.push(i);\n}\nassert_eq!(vec.len(), 10);\nassert!(vec.capacity() >= 10);\n\n// ...but this may make the vector reallocate\nvec.push(11);\nassert_eq!(vec.len(), 11);\nassert!(vec.capacity() >= 11);\n\n// A vector of a zero-sized type will always over-allocate, since no\n// allocation is necessary\nlet vec_units = Vec::<(), System>::with_capacity_in(10, System);\nassert_eq!(vec_units.capacity(), usize::MAX);
\n
source

pub fn try_with_capacity_in(\n capacity: usize,\n alloc: A\n) -> Result<Vec<T, A>, TryReserveError>

🔬This is a nightly-only experimental API. (allocator_api)

Constructs a new, empty Vec<T, A> with at least the specified capacity\nwith the provided allocator.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n
§Errors
\n

Returns an error if the capacity exceeds isize::MAX bytes,\nor if the allocator reports allocation failure.

\n
source

pub unsafe fn from_raw_parts_in(\n ptr: *mut T,\n length: usize,\n capacity: usize,\n alloc: A\n) -> Vec<T, A>

🔬This is a nightly-only experimental API. (allocator_api)

Creates a Vec<T, A> directly from a pointer, a length, a capacity,\nand an allocator.

\n
§Safety
\n

This is highly unsafe, due to the number of invariants that aren’t\nchecked:

\n
    \n
  • ptr must be currently allocated via the given allocator alloc.
    • \n
  • T needs to have the same alignment as what ptr was allocated with.\n(T having a less strict alignment is not sufficient, the alignment really\nneeds to be equal to satisfy the dealloc requirement that memory must be\nallocated and deallocated with the same layout.)
    • \n
  • The size of T times the capacity (ie. the allocated size in bytes) needs\nto be the same size as the pointer was allocated with. (Because similar to\nalignment, dealloc must be called with the same layout size.)
    • \n
  • length needs to be less than or equal to capacity.
    • \n
  • The first length values must be properly initialized values of type T.
    • \n
  • capacity needs to fit the layout size that the pointer was allocated with.
    • \n
  • The allocated size in bytes must be no larger than isize::MAX.\nSee the safety documentation of pointer::offset.
    • \n
\n

These requirements are always upheld by any ptr that has been allocated\nvia Vec<T, A>. Other allocation sources are allowed if the invariants are\nupheld.

\n

Violating these may cause problems like corrupting the allocator’s\ninternal data structures. For example it is not safe\nto build a Vec<u8> from a pointer to a C char array with length size_t.\nIt’s also not safe to build one from a Vec<u16> and its length, because\nthe allocator cares about the alignment, and these two types have different\nalignments. The buffer was allocated with alignment 2 (for u16), but after\nturning it into a Vec<u8> it’ll be deallocated with alignment 1.

\n

The ownership of ptr is effectively transferred to the\nVec<T> which may then deallocate, reallocate or change the\ncontents of memory pointed to by the pointer at will. Ensure\nthat nothing else uses the pointer after calling this\nfunction.

\n
§Examples
\n
#![feature(allocator_api)]\n\nuse std::alloc::System;\n\nuse std::ptr;\nuse std::mem;\n\nlet mut v = Vec::with_capacity_in(3, System);\nv.push(1);\nv.push(2);\nv.push(3);\n\n// Prevent running `v`'s destructor so we are in complete control\n// of the allocation.\nlet mut v = mem::ManuallyDrop::new(v);\n\n// Pull out the various important pieces of information about `v`\nlet p = v.as_mut_ptr();\nlet len = v.len();\nlet cap = v.capacity();\nlet alloc = v.allocator();\n\nunsafe {\n    // Overwrite memory with 4, 5, 6\n    for i in 0..len {\n        ptr::write(p.add(i), 4 + i);\n    }\n\n    // Put everything back together into a Vec\n    let rebuilt = Vec::from_raw_parts_in(p, len, cap, alloc.clone());\n    assert_eq!(rebuilt, [4, 5, 6]);\n}
\n

Using memory that was allocated elsewhere:

\n\n
#![feature(allocator_api)]\n\nuse std::alloc::{AllocError, Allocator, Global, Layout};\n\nfn main() {\n    let layout = Layout::array::<u32>(16).expect(\"overflow cannot happen\");\n\n    let vec = unsafe {\n        let mem = match Global.allocate(layout) {\n            Ok(mem) => mem.cast::<u32>().as_ptr(),\n            Err(AllocError) => return,\n        };\n\n        mem.write(1_000_000);\n\n        Vec::from_raw_parts_in(mem, 1, 16, Global)\n    };\n\n    assert_eq!(vec, &[1_000_000]);\n    assert_eq!(vec.capacity(), 16);\n}
\n
source

pub fn into_raw_parts(self) -> (*mut T, usize, usize)

🔬This is a nightly-only experimental API. (vec_into_raw_parts)

Decomposes a Vec<T> into its raw components: (pointer, length, capacity).

\n

Returns the raw pointer to the underlying data, the length of\nthe vector (in elements), and the allocated capacity of the\ndata (in elements). These are the same arguments in the same\norder as the arguments to from_raw_parts.

\n

After calling this function, the caller is responsible for the\nmemory previously managed by the Vec. The only way to do\nthis is to convert the raw pointer, length, and capacity back\ninto a Vec with the from_raw_parts function, allowing\nthe destructor to perform the cleanup.

\n
§Examples
\n
#![feature(vec_into_raw_parts)]\nlet v: Vec<i32> = vec![-1, 0, 1];\n\nlet (ptr, len, cap) = v.into_raw_parts();\n\nlet rebuilt = unsafe {\n    // We can now make changes to the components, such as\n    // transmuting the raw pointer to a compatible type.\n    let ptr = ptr as *mut u32;\n\n    Vec::from_raw_parts(ptr, len, cap)\n};\nassert_eq!(rebuilt, [4294967295, 0, 1]);
\n
source

pub fn into_raw_parts_with_alloc(self) -> (*mut T, usize, usize, A)

🔬This is a nightly-only experimental API. (allocator_api)

Decomposes a Vec<T> into its raw components: (pointer, length, capacity, allocator).

\n

Returns the raw pointer to the underlying data, the length of the vector (in elements),\nthe allocated capacity of the data (in elements), and the allocator. These are the same\narguments in the same order as the arguments to from_raw_parts_in.

\n

After calling this function, the caller is responsible for the\nmemory previously managed by the Vec. The only way to do\nthis is to convert the raw pointer, length, and capacity back\ninto a Vec with the from_raw_parts_in function, allowing\nthe destructor to perform the cleanup.

\n
§Examples
\n
#![feature(allocator_api, vec_into_raw_parts)]\n\nuse std::alloc::System;\n\nlet mut v: Vec<i32, System> = Vec::new_in(System);\nv.push(-1);\nv.push(0);\nv.push(1);\n\nlet (ptr, len, cap, alloc) = v.into_raw_parts_with_alloc();\n\nlet rebuilt = unsafe {\n    // We can now make changes to the components, such as\n    // transmuting the raw pointer to a compatible type.\n    let ptr = ptr as *mut u32;\n\n    Vec::from_raw_parts_in(ptr, len, cap, alloc)\n};\nassert_eq!(rebuilt, [4294967295, 0, 1]);
\n
1.0.0 · source

pub fn capacity(&self) -> usize

Returns the total number of elements the vector can hold without\nreallocating.

\n
§Examples
\n
let mut vec: Vec<i32> = Vec::with_capacity(10);\nvec.push(42);\nassert!(vec.capacity() >= 10);
\n
1.0.0 · source

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted\nin the given Vec<T>. The collection may reserve more space to\nspeculatively avoid frequent reallocations. After calling reserve,\ncapacity will be greater than or equal to self.len() + additional.\nDoes nothing if capacity is already sufficient.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1];\nvec.reserve(10);\nassert!(vec.capacity() >= 11);
\n
1.0.0 · source

pub fn reserve_exact(&mut self, additional: usize)

Reserves the minimum capacity for at least additional more elements to\nbe inserted in the given Vec<T>. Unlike reserve, this will not\ndeliberately over-allocate to speculatively avoid frequent allocations.\nAfter calling reserve_exact, capacity will be greater than or equal to\nself.len() + additional. Does nothing if the capacity is already\nsufficient.

\n

Note that the allocator may give the collection more space than it\nrequests. Therefore, capacity can not be relied upon to be precisely\nminimal. Prefer reserve if future insertions are expected.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1];\nvec.reserve_exact(10);\nassert!(vec.capacity() >= 11);
\n
1.57.0 · source

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Tries to reserve capacity for at least additional more elements to be inserted\nin the given Vec<T>. The collection may reserve more space to speculatively avoid\nfrequent reallocations. After calling try_reserve, capacity will be\ngreater than or equal to self.len() + additional if it returns\nOk(()). Does nothing if capacity is already sufficient. This method\npreserves the contents even if an error occurs.

\n
§Errors
\n

If the capacity overflows, or the allocator reports a failure, then an error\nis returned.

\n
§Examples
\n
use std::collections::TryReserveError;\n\nfn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {\n    let mut output = Vec::new();\n\n    // Pre-reserve the memory, exiting if we can't\n    output.try_reserve(data.len())?;\n\n    // Now we know this can't OOM in the middle of our complex work\n    output.extend(data.iter().map(|&val| {\n        val * 2 + 5 // very complicated\n    }));\n\n    Ok(output)\n}
\n
1.57.0 · source

pub fn try_reserve_exact(\n &mut self,\n additional: usize\n) -> Result<(), TryReserveError>

Tries to reserve the minimum capacity for at least additional\nelements to be inserted in the given Vec<T>. Unlike try_reserve,\nthis will not deliberately over-allocate to speculatively avoid frequent\nallocations. After calling try_reserve_exact, capacity will be greater\nthan or equal to self.len() + additional if it returns Ok(()).\nDoes nothing if the capacity is already sufficient.

\n

Note that the allocator may give the collection more space than it\nrequests. Therefore, capacity can not be relied upon to be precisely\nminimal. Prefer try_reserve if future insertions are expected.

\n
§Errors
\n

If the capacity overflows, or the allocator reports a failure, then an error\nis returned.

\n
§Examples
\n
use std::collections::TryReserveError;\n\nfn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {\n    let mut output = Vec::new();\n\n    // Pre-reserve the memory, exiting if we can't\n    output.try_reserve_exact(data.len())?;\n\n    // Now we know this can't OOM in the middle of our complex work\n    output.extend(data.iter().map(|&val| {\n        val * 2 + 5 // very complicated\n    }));\n\n    Ok(output)\n}
\n
1.0.0 · source

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the vector as much as possible.

\n

The behavior of this method depends on the allocator, which may either shrink the vector\nin-place or reallocate. The resulting vector might still have some excess capacity, just as\nis the case for with_capacity. See Allocator::shrink for more details.

\n
§Examples
\n
let mut vec = Vec::with_capacity(10);\nvec.extend([1, 2, 3]);\nassert!(vec.capacity() >= 10);\nvec.shrink_to_fit();\nassert!(vec.capacity() >= 3);
\n
1.56.0 · source

pub fn shrink_to(&mut self, min_capacity: usize)

Shrinks the capacity of the vector with a lower bound.

\n

The capacity will remain at least as large as both the length\nand the supplied value.

\n

If the current capacity is less than the lower limit, this is a no-op.

\n
§Examples
\n
let mut vec = Vec::with_capacity(10);\nvec.extend([1, 2, 3]);\nassert!(vec.capacity() >= 10);\nvec.shrink_to(4);\nassert!(vec.capacity() >= 4);\nvec.shrink_to(0);\nassert!(vec.capacity() >= 3);
\n
1.0.0 · source

pub fn into_boxed_slice(self) -> Box<[T], A>

Converts the vector into Box<[T]>.

\n

Before doing the conversion, this method discards excess capacity like shrink_to_fit.

\n
§Examples
\n
let v = vec![1, 2, 3];\n\nlet slice = v.into_boxed_slice();
\n

Any excess capacity is removed:

\n\n
let mut vec = Vec::with_capacity(10);\nvec.extend([1, 2, 3]);\n\nassert!(vec.capacity() >= 10);\nlet slice = vec.into_boxed_slice();\nassert_eq!(slice.into_vec().capacity(), 3);
\n
1.0.0 · source

pub fn truncate(&mut self, len: usize)

Shortens the vector, keeping the first len elements and dropping\nthe rest.

\n

If len is greater or equal to the vector’s current length, this has\nno effect.

\n

The drain method can emulate truncate, but causes the excess\nelements to be returned instead of dropped.

\n

Note that this method has no effect on the allocated capacity\nof the vector.

\n
§Examples
\n

Truncating a five element vector to two elements:

\n\n
let mut vec = vec![1, 2, 3, 4, 5];\nvec.truncate(2);\nassert_eq!(vec, [1, 2]);
\n

No truncation occurs when len is greater than the vector’s current\nlength:

\n\n
let mut vec = vec![1, 2, 3];\nvec.truncate(8);\nassert_eq!(vec, [1, 2, 3]);
\n

Truncating when len == 0 is equivalent to calling the clear\nmethod.

\n\n
let mut vec = vec![1, 2, 3];\nvec.truncate(0);\nassert_eq!(vec, []);
\n
1.7.0 · source

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

\n

Equivalent to &s[..].

\n
§Examples
\n
use std::io::{self, Write};\nlet buffer = vec![1, 2, 3, 5, 8];\nio::sink().write(buffer.as_slice()).unwrap();
\n
1.7.0 · source

pub fn as_mut_slice(&mut self) -> &mut [T]

Extracts a mutable slice of the entire vector.

\n

Equivalent to &mut s[..].

\n
§Examples
\n
use std::io::{self, Read};\nlet mut buffer = vec![0; 3];\nio::repeat(0b101).read_exact(buffer.as_mut_slice()).unwrap();
\n
1.37.0 · source

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer, or a dangling raw pointer\nvalid for zero sized reads if the vector didn’t allocate.

\n

The caller must ensure that the vector outlives the pointer this\nfunction returns, or else it will end up pointing to garbage.\nModifying the vector may cause its buffer to be reallocated,\nwhich would also make any pointers to it invalid.

\n

The caller must also ensure that the memory the pointer (non-transitively) points to\nis never written to (except inside an UnsafeCell) using this pointer or any pointer\nderived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

\n

This method guarantees that for the purpose of the aliasing model, this method\ndoes not materialize a reference to the underlying slice, and thus the returned pointer\nwill remain valid when mixed with other calls to as_ptr and as_mut_ptr.\nNote that calling other methods that materialize mutable references to the slice,\nor mutable references to specific elements you are planning on accessing through this pointer,\nas well as writing to those elements, may still invalidate this pointer.\nSee the second example below for how this guarantee can be used.

\n
§Examples
\n
let x = vec![1, 2, 4];\nlet x_ptr = x.as_ptr();\n\nunsafe {\n    for i in 0..x.len() {\n        assert_eq!(*x_ptr.add(i), 1 << i);\n    }\n}
\n

Due to the aliasing guarantee, the following code is legal:

\n\n
unsafe {\n    let mut v = vec![0, 1, 2];\n    let ptr1 = v.as_ptr();\n    let _ = ptr1.read();\n    let ptr2 = v.as_mut_ptr().offset(2);\n    ptr2.write(2);\n    // Notably, the write to `ptr2` did *not* invalidate `ptr1`\n    // because it mutated a different element:\n    let _ = ptr1.read();\n}
\n
1.37.0 · source

pub fn as_mut_ptr(&mut self) -> *mut T

Returns an unsafe mutable pointer to the vector’s buffer, or a dangling\nraw pointer valid for zero sized reads if the vector didn’t allocate.

\n

The caller must ensure that the vector outlives the pointer this\nfunction returns, or else it will end up pointing to garbage.\nModifying the vector may cause its buffer to be reallocated,\nwhich would also make any pointers to it invalid.

\n

This method guarantees that for the purpose of the aliasing model, this method\ndoes not materialize a reference to the underlying slice, and thus the returned pointer\nwill remain valid when mixed with other calls to as_ptr and as_mut_ptr.\nNote that calling other methods that materialize references to the slice,\nor references to specific elements you are planning on accessing through this pointer,\nmay still invalidate this pointer.\nSee the second example below for how this guarantee can be used.

\n
§Examples
\n
// Allocate vector big enough for 4 elements.\nlet size = 4;\nlet mut x: Vec<i32> = Vec::with_capacity(size);\nlet x_ptr = x.as_mut_ptr();\n\n// Initialize elements via raw pointer writes, then set length.\nunsafe {\n    for i in 0..size {\n        *x_ptr.add(i) = i as i32;\n    }\n    x.set_len(size);\n}\nassert_eq!(&*x, &[0, 1, 2, 3]);
\n

Due to the aliasing guarantee, the following code is legal:

\n\n
unsafe {\n    let mut v = vec![0];\n    let ptr1 = v.as_mut_ptr();\n    ptr1.write(1);\n    let ptr2 = v.as_mut_ptr();\n    ptr2.write(2);\n    // Notably, the write to `ptr2` did *not* invalidate `ptr1`:\n    ptr1.write(3);\n}
\n
source

pub fn allocator(&self) -> &A

🔬This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

\n
1.0.0 · source

pub unsafe fn set_len(&mut self, new_len: usize)

Forces the length of the vector to new_len.

\n

This is a low-level operation that maintains none of the normal\ninvariants of the type. Normally changing the length of a vector\nis done using one of the safe operations instead, such as\ntruncate, resize, extend, or clear.

\n
§Safety
\n
    \n
  • new_len must be less than or equal to capacity().
    • \n
  • The elements at old_len..new_len must be initialized.
    • \n
\n
§Examples
\n

This method can be useful for situations in which the vector\nis serving as a buffer for other code, particularly over FFI:

\n\n
pub fn get_dictionary(&self) -> Option<Vec<u8>> {\n    // Per the FFI method's docs, \"32768 bytes is always enough\".\n    let mut dict = Vec::with_capacity(32_768);\n    let mut dict_length = 0;\n    // SAFETY: When `deflateGetDictionary` returns `Z_OK`, it holds that:\n    // 1. `dict_length` elements were initialized.\n    // 2. `dict_length` <= the capacity (32_768)\n    // which makes `set_len` safe to call.\n    unsafe {\n        // Make the FFI call...\n        let r = deflateGetDictionary(self.strm, dict.as_mut_ptr(), &mut dict_length);\n        if r == Z_OK {\n            // ...and update the length to what was initialized.\n            dict.set_len(dict_length);\n            Some(dict)\n        } else {\n            None\n        }\n    }\n}
\n

While the following example is sound, there is a memory leak since\nthe inner vectors were not freed prior to the set_len call:

\n\n
let mut vec = vec![vec![1, 0, 0],\n                   vec![0, 1, 0],\n                   vec![0, 0, 1]];\n// SAFETY:\n// 1. `old_len..0` is empty so no elements need to be initialized.\n// 2. `0 <= capacity` always holds whatever `capacity` is.\nunsafe {\n    vec.set_len(0);\n}
\n

Normally, here, one would use clear instead to correctly drop\nthe contents and thus not leak memory.

\n
1.0.0 · source

pub fn swap_remove(&mut self, index: usize) -> T

Removes an element from the vector and returns it.

\n

The removed element is replaced by the last element of the vector.

\n

This does not preserve ordering, but is O(1).\nIf you need to preserve the element order, use remove instead.

\n
§Panics
\n

Panics if index is out of bounds.

\n
§Examples
\n
let mut v = vec![\"foo\", \"bar\", \"baz\", \"qux\"];\n\nassert_eq!(v.swap_remove(1), \"bar\");\nassert_eq!(v, [\"foo\", \"qux\", \"baz\"]);\n\nassert_eq!(v.swap_remove(0), \"foo\");\nassert_eq!(v, [\"baz\", \"qux\"]);
\n
1.0.0 · source

pub fn insert(&mut self, index: usize, element: T)

Inserts an element at position index within the vector, shifting all\nelements after it to the right.

\n
§Panics
\n

Panics if index > len.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nvec.insert(1, 4);\nassert_eq!(vec, [1, 4, 2, 3]);\nvec.insert(4, 5);\nassert_eq!(vec, [1, 4, 2, 3, 5]);
\n
§Time complexity
\n

Takes O(Vec::len) time. All items after the insertion index must be\nshifted to the right. In the worst case, all elements are shifted when\nthe insertion index is 0.

\n
1.0.0 · source

pub fn remove(&mut self, index: usize) -> T

Removes and returns the element at position index within the vector,\nshifting all elements after it to the left.

\n

Note: Because this shifts over the remaining elements, it has a\nworst-case performance of O(n). If you don’t need the order of elements\nto be preserved, use swap_remove instead. If you’d like to remove\nelements from the beginning of the Vec, consider using\nVecDeque::pop_front instead.

\n
§Panics
\n

Panics if index is out of bounds.

\n
§Examples
\n
let mut v = vec![1, 2, 3];\nassert_eq!(v.remove(1), 2);\nassert_eq!(v, [1, 3]);
\n
1.0.0 · source

pub fn retain<F>(&mut self, f: F)
where\n F: FnMut(&T) -> bool,

Retains only the elements specified by the predicate.

\n

In other words, remove all elements e for which f(&e) returns false.\nThis method operates in place, visiting each element exactly once in the\noriginal order, and preserves the order of the retained elements.

\n
§Examples
\n
let mut vec = vec![1, 2, 3, 4];\nvec.retain(|&x| x % 2 == 0);\nassert_eq!(vec, [2, 4]);
\n

Because the elements are visited exactly once in the original order,\nexternal state may be used to decide which elements to keep.

\n\n
let mut vec = vec![1, 2, 3, 4, 5];\nlet keep = [false, true, true, false, true];\nlet mut iter = keep.iter();\nvec.retain(|_| *iter.next().unwrap());\nassert_eq!(vec, [2, 3, 5]);
\n
1.61.0 · source

pub fn retain_mut<F>(&mut self, f: F)
where\n F: FnMut(&mut T) -> bool,

Retains only the elements specified by the predicate, passing a mutable reference to it.

\n

In other words, remove all elements e such that f(&mut e) returns false.\nThis method operates in place, visiting each element exactly once in the\noriginal order, and preserves the order of the retained elements.

\n
§Examples
\n
let mut vec = vec![1, 2, 3, 4];\nvec.retain_mut(|x| if *x <= 3 {\n    *x += 1;\n    true\n} else {\n    false\n});\nassert_eq!(vec, [2, 3, 4]);
\n
1.16.0 · source

pub fn dedup_by_key<F, K>(&mut self, key: F)
where\n F: FnMut(&mut T) -> K,\n K: PartialEq,

Removes all but the first of consecutive elements in the vector that resolve to the same\nkey.

\n

If the vector is sorted, this removes all duplicates.

\n
§Examples
\n
let mut vec = vec![10, 20, 21, 30, 20];\n\nvec.dedup_by_key(|i| *i / 10);\n\nassert_eq!(vec, [10, 20, 30, 20]);
\n
1.16.0 · source

pub fn dedup_by<F>(&mut self, same_bucket: F)
where\n F: FnMut(&mut T, &mut T) -> bool,

Removes all but the first of consecutive elements in the vector satisfying a given equality\nrelation.

\n

The same_bucket function is passed references to two elements from the vector and\nmust determine if the elements compare equal. The elements are passed in opposite order\nfrom their order in the slice, so if same_bucket(a, b) returns true, a is removed.

\n

If the vector is sorted, this removes all duplicates.

\n
§Examples
\n
let mut vec = vec![\"foo\", \"bar\", \"Bar\", \"baz\", \"bar\"];\n\nvec.dedup_by(|a, b| a.eq_ignore_ascii_case(b));\n\nassert_eq!(vec, [\"foo\", \"bar\", \"baz\", \"bar\"]);
\n
1.0.0 · source

pub fn push(&mut self, value: T)

Appends an element to the back of a collection.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1, 2];\nvec.push(3);\nassert_eq!(vec, [1, 2, 3]);
\n
§Time complexity
\n

Takes amortized O(1) time. If the vector’s length would exceed its\ncapacity after the push, O(capacity) time is taken to copy the\nvector’s elements to a larger allocation. This expensive operation is\noffset by the capacity O(1) insertions it allows.

\n
source

pub fn push_within_capacity(&mut self, value: T) -> Result<(), T>

🔬This is a nightly-only experimental API. (vec_push_within_capacity)

Appends an element if there is sufficient spare capacity, otherwise an error is returned\nwith the element.

\n

Unlike push this method will not reallocate when there’s insufficient capacity.\nThe caller should use reserve or try_reserve to ensure that there is enough capacity.

\n
§Examples
\n

A manual, panic-free alternative to FromIterator:

\n\n
#![feature(vec_push_within_capacity)]\n\nuse std::collections::TryReserveError;\nfn from_iter_fallible<T>(iter: impl Iterator<Item=T>) -> Result<Vec<T>, TryReserveError> {\n    let mut vec = Vec::new();\n    for value in iter {\n        if let Err(value) = vec.push_within_capacity(value) {\n            vec.try_reserve(1)?;\n            // this cannot fail, the previous line either returned or added at least 1 free slot\n            let _ = vec.push_within_capacity(value);\n        }\n    }\n    Ok(vec)\n}\nassert_eq!(from_iter_fallible(0..100), Ok(Vec::from_iter(0..100)));
\n
§Time complexity
\n

Takes O(1) time.

\n
1.0.0 · source

pub fn pop(&mut self) -> Option<T>

Removes the last element from a vector and returns it, or None if it\nis empty.

\n

If you’d like to pop the first element, consider using\nVecDeque::pop_front instead.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nassert_eq!(vec.pop(), Some(3));\nassert_eq!(vec, [1, 2]);
\n
§Time complexity
\n

Takes O(1) time.

\n
1.4.0 · source

pub fn append(&mut self, other: &mut Vec<T, A>)

Moves all the elements of other into self, leaving other empty.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nlet mut vec2 = vec![4, 5, 6];\nvec.append(&mut vec2);\nassert_eq!(vec, [1, 2, 3, 4, 5, 6]);\nassert_eq!(vec2, []);
\n
1.6.0 · source

pub fn drain<R>(&mut self, range: R) -> Drain<'_, T, A>
where\n R: RangeBounds<usize>,

Removes the specified range from the vector in bulk, returning all\nremoved elements as an iterator. If the iterator is dropped before\nbeing fully consumed, it drops the remaining removed elements.

\n

The returned iterator keeps a mutable borrow on the vector to optimize\nits implementation.

\n
§Panics
\n

Panics if the starting point is greater than the end point or if\nthe end point is greater than the length of the vector.

\n
§Leaking
\n

If the returned iterator goes out of scope without being dropped (due to\nmem::forget, for example), the vector may have lost and leaked\nelements arbitrarily, including elements outside the range.

\n
§Examples
\n
let mut v = vec![1, 2, 3];\nlet u: Vec<_> = v.drain(1..).collect();\nassert_eq!(v, &[1]);\nassert_eq!(u, &[2, 3]);\n\n// A full range clears the vector, like `clear()` does\nv.drain(..);\nassert_eq!(v, &[]);
\n
1.0.0 · source

pub fn clear(&mut self)

Clears the vector, removing all values.

\n

Note that this method has no effect on the allocated capacity\nof the vector.

\n
§Examples
\n
let mut v = vec![1, 2, 3];\n\nv.clear();\n\nassert!(v.is_empty());
\n
1.0.0 · source

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to\nas its ‘length’.

\n
§Examples
\n
let a = vec![1, 2, 3];\nassert_eq!(a.len(), 3);
\n
1.0.0 · source

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

\n
§Examples
\n
let mut v = Vec::new();\nassert!(v.is_empty());\n\nv.push(1);\nassert!(!v.is_empty());
\n
1.4.0 · source

pub fn split_off(&mut self, at: usize) -> Vec<T, A>
where\n A: Clone,

Splits the collection into two at the given index.

\n

Returns a newly allocated vector containing the elements in the range\n[at, len). After the call, the original vector will be left containing\nthe elements [0, at) with its previous capacity unchanged.

\n
    \n
  • If you want to take ownership of the entire contents and capacity of\nthe vector, see mem::take or mem::replace.
    • \n
  • If you don’t need the returned vector at all, see Vec::truncate.
    • \n
  • If you want to take ownership of an arbitrary subslice, or you don’t\nnecessarily want to store the removed items in a vector, see Vec::drain.
    • \n
\n
§Panics
\n

Panics if at > len.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nlet vec2 = vec.split_off(1);\nassert_eq!(vec, [1]);\nassert_eq!(vec2, [2, 3]);
\n
1.33.0 · source

pub fn resize_with<F>(&mut self, new_len: usize, f: F)
where\n F: FnMut() -> T,

Resizes the Vec in-place so that len is equal to new_len.

\n

If new_len is greater than len, the Vec is extended by the\ndifference, with each additional slot filled with the result of\ncalling the closure f. The return values from f will end up\nin the Vec in the order they have been generated.

\n

If new_len is less than len, the Vec is simply truncated.

\n

This method uses a closure to create new values on every push. If\nyou’d rather Clone a given value, use Vec::resize. If you\nwant to use the Default trait to generate values, you can\npass Default::default as the second argument.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nvec.resize_with(5, Default::default);\nassert_eq!(vec, [1, 2, 3, 0, 0]);\n\nlet mut vec = vec![];\nlet mut p = 1;\nvec.resize_with(4, || { p *= 2; p });\nassert_eq!(vec, [2, 4, 8, 16]);
\n
1.47.0 · source

pub fn leak<'a>(self) -> &'a mut [T]
where\n A: 'a,

Consumes and leaks the Vec, returning a mutable reference to the contents,\n&'a mut [T]. Note that the type T must outlive the chosen lifetime\n'a. If the type has only static references, or none at all, then this\nmay be chosen to be 'static.

\n

As of Rust 1.57, this method does not reallocate or shrink the Vec,\nso the leaked allocation may include unused capacity that is not part\nof the returned slice.

\n

This function is mainly useful for data that lives for the remainder of\nthe program’s life. Dropping the returned reference will cause a memory\nleak.

\n
§Examples
\n

Simple usage:

\n\n
let x = vec![1, 2, 3];\nlet static_ref: &'static mut [usize] = x.leak();\nstatic_ref[0] += 1;\nassert_eq!(static_ref, &[2, 2, 3]);
\n
1.60.0 · source

pub fn spare_capacity_mut(&mut self) -> &mut [MaybeUninit<T>]

Returns the remaining spare capacity of the vector as a slice of\nMaybeUninit<T>.

\n

The returned slice can be used to fill the vector with data (e.g. by\nreading from a file) before marking the data as initialized using the\nset_len method.

\n
§Examples
\n
// Allocate vector big enough for 10 elements.\nlet mut v = Vec::with_capacity(10);\n\n// Fill in the first 3 elements.\nlet uninit = v.spare_capacity_mut();\nuninit[0].write(0);\nuninit[1].write(1);\nuninit[2].write(2);\n\n// Mark the first 3 elements of the vector as being initialized.\nunsafe {\n    v.set_len(3);\n}\n\nassert_eq!(&v, &[0, 1, 2]);
\n
source

pub fn split_at_spare_mut(&mut self) -> (&mut [T], &mut [MaybeUninit<T>])

🔬This is a nightly-only experimental API. (vec_split_at_spare)

Returns vector content as a slice of T, along with the remaining spare\ncapacity of the vector as a slice of MaybeUninit<T>.

\n

The returned spare capacity slice can be used to fill the vector with data\n(e.g. by reading from a file) before marking the data as initialized using\nthe set_len method.

\n

Note that this is a low-level API, which should be used with care for\noptimization purposes. If you need to append data to a Vec\nyou can use push, extend, extend_from_slice,\nextend_from_within, insert, append, resize or\nresize_with, depending on your exact needs.

\n
§Examples
\n
#![feature(vec_split_at_spare)]\n\nlet mut v = vec![1, 1, 2];\n\n// Reserve additional space big enough for 10 elements.\nv.reserve(10);\n\nlet (init, uninit) = v.split_at_spare_mut();\nlet sum = init.iter().copied().sum::<u32>();\n\n// Fill in the next 4 elements.\nuninit[0].write(sum);\nuninit[1].write(sum * 2);\nuninit[2].write(sum * 3);\nuninit[3].write(sum * 4);\n\n// Mark the 4 elements of the vector as being initialized.\nunsafe {\n    let len = v.len();\n    v.set_len(len + 4);\n}\n\nassert_eq!(&v, &[1, 1, 2, 4, 8, 12, 16]);
\n
",0,"toml::value::Array"],["
1.0.0 · source§

impl<T, A> Eq for Vec<T, A>
where\n T: Eq,\n A: Allocator,

","Eq","toml::value::Array"]] +"toml":[["
source§

impl<'i, T> Accumulate<&'i [T]> for Vec<T>
where\n T: Clone,

source§

fn initial(capacity: Option<usize>) -> Vec<T>

Create a new Extend of the correct type
source§

fn accumulate(&mut self, acc: &'i [T])

Accumulate the input into an accumulator
","Accumulate<&'i [T]>","toml::value::Array"],["
source§

impl<T> Accumulate<T> for Vec<T>

source§

fn initial(capacity: Option<usize>) -> Vec<T>

Create a new Extend of the correct type
source§

fn accumulate(&mut self, acc: T)

Accumulate the input into an accumulator
","Accumulate","toml::value::Array"],["
1.5.0 · source§

impl<T, A> AsMut<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.
","AsMut<[T]>","toml::value::Array"],["
1.5.0 · source§

impl<T, A> AsMut<Vec<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn as_mut(&mut self) -> &mut Vec<T, A>

Converts this type into a mutable reference of the (usually inferred) input type.
","AsMut>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> AsRef<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.
","AsRef<[T]>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> AsRef<Vec<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn as_ref(&self) -> &Vec<T, A>

Converts this type into a shared reference of the (usually inferred) input type.
","AsRef>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Borrow<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn borrow(&self) -> &[T]

Immutably borrows from an owned value. Read more
","Borrow<[T]>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> BorrowMut<[T]> for Vec<T, A>
where\n A: Allocator,

source§

fn borrow_mut(&mut self) -> &mut [T]

Mutably borrows from an owned value. Read more
","BorrowMut<[T]>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Clone for Vec<T, A>
where\n T: Clone,\n A: Allocator + Clone,

source§

fn clone(&self) -> Vec<T, A>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, other: &Vec<T, A>)

Performs copy-assignment from source. Read more
","Clone","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Debug for Vec<T, A>
where\n T: Debug,\n A: Allocator,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","toml::value::Array"],["
1.0.0 · source§

impl<T> Default for Vec<T>

source§

fn default() -> Vec<T>

Creates an empty Vec<T>.

\n

The vector will not allocate until elements are pushed onto it.

\n
","Default","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Deref for Vec<T, A>
where\n A: Allocator,

§

type Target = [T]

The resulting type after dereferencing.
source§

fn deref(&self) -> &[T]

Dereferences the value.
","Deref","toml::value::Array"],["
1.0.0 · source§

impl<T, A> DerefMut for Vec<T, A>
where\n A: Allocator,

source§

fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.
","DerefMut","toml::value::Array"],["
source§

impl<'de, T> Deserialize<'de> for Vec<T>
where\n T: Deserialize<'de>,

source§

fn deserialize<D>(\n deserializer: D\n) -> Result<Vec<T>, <D as Deserializer<'de>>::Error>
where\n D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
","Deserialize<'de>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Drop for Vec<T, A>
where\n A: Allocator,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
","Drop","toml::value::Array"],["
1.2.0 · source§

impl<'a, T, A> Extend<&'a T> for Vec<T, A>
where\n T: Copy + 'a,\n A: Allocator,

Extend implementation that copies elements out of references before pushing them onto the Vec.

\n

This implementation is specialized for slice iterators, where it uses copy_from_slice to\nappend the entire slice at once.

\n
source§

fn extend<I>(&mut self, iter: I)
where\n I: IntoIterator<Item = &'a T>,

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, _: &'a T)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
","Extend<&'a T>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Extend<T> for Vec<T, A>
where\n A: Allocator,

source§

fn extend<I>(&mut self, iter: I)
where\n I: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
","Extend","toml::value::Array"],["
1.0.0 · source§

impl<T> From<&[T]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &[T]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&[1, 2, 3][..]), vec![1, 2, 3]);
\n
","From<&[T]>","toml::value::Array"],["
1.74.0 · source§

impl<T, const N: usize> From<&[T; N]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &[T; N]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&[1, 2, 3]), vec![1, 2, 3]);
\n
","From<&[T; N]>","toml::value::Array"],["
1.19.0 · source§

impl<T> From<&mut [T]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &mut [T]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&mut [1, 2, 3][..]), vec![1, 2, 3]);
\n
","From<&mut [T]>","toml::value::Array"],["
1.74.0 · source§

impl<T, const N: usize> From<&mut [T; N]> for Vec<T>
where\n T: Clone,

source§

fn from(s: &mut [T; N]) -> Vec<T>

Allocate a Vec<T> and fill it by cloning s’s items.

\n
§Examples
\n
assert_eq!(Vec::from(&mut [1, 2, 3]), vec![1, 2, 3]);
\n
","From<&mut [T; N]>","toml::value::Array"],["
1.44.0 · source§

impl<T, const N: usize> From<[T; N]> for Vec<T>

source§

fn from(s: [T; N]) -> Vec<T>

Allocate a Vec<T> and move s’s items into it.

\n
§Examples
\n
assert_eq!(Vec::from([1, 2, 3]), vec![1, 2, 3]);
\n
","From<[T; N]>","toml::value::Array"],["
1.5.0 · source§

impl<T, A> From<BinaryHeap<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn from(heap: BinaryHeap<T, A>) -> Vec<T, A>

Converts a BinaryHeap<T> into a Vec<T>.

\n

This conversion requires no data movement or allocation, and has\nconstant time complexity.

\n
","From>","toml::value::Array"],["
1.18.0 · source§

impl<T, A> From<Box<[T], A>> for Vec<T, A>
where\n A: Allocator,

source§

fn from(s: Box<[T], A>) -> Vec<T, A>

Convert a boxed slice into a vector by transferring ownership of\nthe existing heap allocation.

\n
§Examples
\n
let b: Box<[i32]> = vec![1, 2, 3].into_boxed_slice();\nassert_eq!(Vec::from(b), vec![1, 2, 3]);
\n
","From>","toml::value::Array"],["
1.14.0 · source§

impl<'a, T> From<Cow<'a, [T]>> for Vec<T>
where\n [T]: ToOwned<Owned = Vec<T>>,

source§

fn from(s: Cow<'a, [T]>) -> Vec<T>

Convert a clone-on-write slice into a vector.

\n

If s already owns a Vec<T>, it will be returned directly.\nIf s is borrowing a slice, a new Vec<T> will be allocated and\nfilled by cloning s’s items into it.

\n
§Examples
\n
let o: Cow<'_, [i32]> = Cow::Owned(vec![1, 2, 3]);\nlet b: Cow<'_, [i32]> = Cow::Borrowed(&[1, 2, 3]);\nassert_eq!(Vec::from(o), Vec::from(b));
\n
","From>","toml::value::Array"],["
1.10.0 · source§

impl<T, A> From<VecDeque<T, A>> for Vec<T, A>
where\n A: Allocator,

source§

fn from(other: VecDeque<T, A>) -> Vec<T, A>

Turn a VecDeque<T> into a Vec<T>.

\n

This never needs to re-allocate, but does need to do O(n) data movement if\nthe circular buffer doesn’t happen to be at the beginning of the allocation.

\n
§Examples
\n
use std::collections::VecDeque;\n\n// This one is *O*(1).\nlet deque: VecDeque<_> = (1..5).collect();\nlet ptr = deque.as_slices().0.as_ptr();\nlet vec = Vec::from(deque);\nassert_eq!(vec, [1, 2, 3, 4]);\nassert_eq!(vec.as_ptr(), ptr);\n\n// This one needs data rearranging.\nlet mut deque: VecDeque<_> = (1..5).collect();\ndeque.push_front(9);\ndeque.push_front(8);\nlet ptr = deque.as_slices().1.as_ptr();\nlet vec = Vec::from(deque);\nassert_eq!(vec, [8, 9, 1, 2, 3, 4]);\nassert_eq!(vec.as_ptr(), ptr);
\n
","From>","toml::value::Array"],["
1.0.0 · source§

impl<T> FromIterator<T> for Vec<T>

Collects an iterator into a Vec, commonly called via Iterator::collect()

\n

§Allocation behavior

\n

In general Vec does not guarantee any particular growth or allocation strategy.\nThat also applies to this trait impl.

\n

Note: This section covers implementation details and is therefore exempt from\nstability guarantees.

\n

Vec may use any or none of the following strategies,\ndepending on the supplied iterator:

\n
    \n
  • preallocate based on Iterator::size_hint()\n
      \n
    • and panic if the number of items is outside the provided lower/upper bounds
      • \n
    \n
    • \n
  • use an amortized growth strategy similar to pushing one item at a time
    • \n
  • perform the iteration in-place on the original allocation backing the iterator
    • \n
\n

The last case warrants some attention. It is an optimization that in many cases reduces peak memory\nconsumption and improves cache locality. But when big, short-lived allocations are created,\nonly a small fraction of their items get collected, no further use is made of the spare capacity\nand the resulting Vec is moved into a longer-lived structure, then this can lead to the large\nallocations having their lifetimes unnecessarily extended which can result in increased memory\nfootprint.

\n

In cases where this is an issue, the excess capacity can be discarded with Vec::shrink_to(),\nVec::shrink_to_fit() or by collecting into Box<[T]> instead, which additionally reduces\nthe size of the long-lived struct.

\n\n
static LONG_LIVED: Mutex<Vec<Vec<u16>>> = Mutex::new(Vec::new());\n\nfor i in 0..10 {\n    let big_temporary: Vec<u16> = (0..1024).collect();\n    // discard most items\n    let mut result: Vec<_> = big_temporary.into_iter().filter(|i| i % 100 == 0).collect();\n    // without this a lot of unused capacity might be moved into the global\n    result.shrink_to_fit();\n    LONG_LIVED.lock().unwrap().push(result);\n}
\n
source§

fn from_iter<I>(iter: I) -> Vec<T>
where\n I: IntoIterator<Item = T>,

Creates a value from an iterator. Read more
","FromIterator","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Hash for Vec<T, A>
where\n T: Hash,\n A: Allocator,

The hash of a vector is the same as that of the corresponding slice,\nas required by the core::borrow::Borrow implementation.

\n\n
use std::hash::BuildHasher;\n\nlet b = std::hash::RandomState::new();\nlet v: Vec<u8> = vec![0xa8, 0x3c, 0x09];\nlet s: &[u8] = &[0xa8, 0x3c, 0x09];\nassert_eq!(b.hash_one(v), b.hash_one(s));
\n
source§

fn hash<H>(&self, state: &mut H)
where\n H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","toml::value::Array"],["
1.0.0 · source§

impl<T, I, A> Index<I> for Vec<T, A>
where\n I: SliceIndex<[T]>,\n A: Allocator,

§

type Output = <I as SliceIndex<[T]>>::Output

The returned type after indexing.
source§

fn index(&self, index: I) -> &<Vec<T, A> as Index<I>>::Output ⓘ

Performs the indexing (container[index]) operation. Read more
","Index","toml::value::Array"],["
1.0.0 · source§

impl<T, I, A> IndexMut<I> for Vec<T, A>
where\n I: SliceIndex<[T]>,\n A: Allocator,

source§

fn index_mut(&mut self, index: I) -> &mut <Vec<T, A> as Index<I>>::Output ⓘ

Performs the mutable indexing (container[index]) operation. Read more
","IndexMut","toml::value::Array"],["
source§

impl<'de, T, E> IntoDeserializer<'de, E> for Vec<T>
where\n T: IntoDeserializer<'de, E>,\n E: Error,

§

type Deserializer = SeqDeserializer<<Vec<T> as IntoIterator>::IntoIter, E>

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> <Vec<T> as IntoDeserializer<'de, E>>::Deserializer ⓘ

Convert this value into a deserializer.
","IntoDeserializer<'de, E>","toml::value::Array"],["
1.0.0 · source§

impl<T, A> IntoIterator for Vec<T, A>
where\n A: Allocator,

source§

fn into_iter(self) -> <Vec<T, A> as IntoIterator>::IntoIter ⓘ

Creates a consuming iterator, that is, one that moves each value out of\nthe vector (from start to end). The vector cannot be used after calling\nthis.

\n
§Examples
\n
let v = vec![\"a\".to_string(), \"b\".to_string()];\nlet mut v_iter = v.into_iter();\n\nlet first_element: Option<String> = v_iter.next();\n\nassert_eq!(first_element, Some(\"a\".to_string()));\nassert_eq!(v_iter.next(), Some(\"b\".to_string()));\nassert_eq!(v_iter.next(), None);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T, A>

Which kind of iterator are we turning this into?
","IntoIterator","toml::value::Array"],["
1.0.0 · source§

impl<T, A> Ord for Vec<T, A>
where\n T: Ord,\n A: Allocator,

Implements ordering of vectors, lexicographically.

\n
source§

fn cmp(&self, other: &Vec<T, A>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A> PartialEq<&[U]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &&[U]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &&[U]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<&[U]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A, const N: usize> PartialEq<&[U; N]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &&[U; N]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &&[U; N]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<&[U; N]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A> PartialEq<&mut [U]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &&mut [U]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &&mut [U]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<&mut [U]>","toml::value::Array"],["
1.48.0 · source§

impl<T, U, A> PartialEq<[U]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &[U]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &[U]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<[U]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A, const N: usize> PartialEq<[U; N]> for Vec<T, A>
where\n A: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &[U; N]) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &[U; N]) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq<[U; N]>","toml::value::Array"],["
1.0.0 · source§

impl<T, U, A1, A2> PartialEq<Vec<U, A2>> for Vec<T, A1>
where\n A1: Allocator,\n A2: Allocator,\n T: PartialEq<U>,

source§

fn eq(&self, other: &Vec<U, A2>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &Vec<U, A2>) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq>","toml::value::Array"],["
1.0.0 · source§

impl<T, A1, A2> PartialOrd<Vec<T, A2>> for Vec<T, A1>
where\n T: PartialOrd,\n A1: Allocator,\n A2: Allocator,

Implements comparison of vectors, lexicographically.

\n
source§

fn partial_cmp(&self, other: &Vec<T, A2>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd>","toml::value::Array"],["
source§

impl<T> Serialize for Vec<T>
where\n T: Serialize,

source§

fn serialize<S>(\n &self,\n serializer: S\n) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where\n S: Serializer,

Serialize this value into the given Serde serializer. Read more
","Serialize","toml::value::Array"],["
source§

impl<T> Vec<T>

1.0.0 (const: 1.39.0) · source

pub const fn new() -> Vec<T>

Constructs a new, empty Vec<T>.

\n

The vector will not allocate until elements are pushed onto it.

\n
§Examples
\n
let mut vec: Vec<i32> = Vec::new();
\n
1.0.0 · source

pub fn with_capacity(capacity: usize) -> Vec<T>

Constructs a new, empty Vec<T> with at least the specified capacity.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n

It is important to note that although the returned vector has the\nminimum capacity specified, the vector will have a zero length. For\nan explanation of the difference between length and capacity, see\nCapacity and reallocation.

\n

If it is important to know the exact allocated capacity of a Vec,\nalways use the capacity method after construction.

\n

For Vec<T> where T is a zero-sized type, there will be no allocation\nand the capacity will always be usize::MAX.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = Vec::with_capacity(10);\n\n// The vector contains no items, even though it has capacity for more\nassert_eq!(vec.len(), 0);\nassert!(vec.capacity() >= 10);\n\n// These are all done without reallocating...\nfor i in 0..10 {\n    vec.push(i);\n}\nassert_eq!(vec.len(), 10);\nassert!(vec.capacity() >= 10);\n\n// ...but this may make the vector reallocate\nvec.push(11);\nassert_eq!(vec.len(), 11);\nassert!(vec.capacity() >= 11);\n\n// A vector of a zero-sized type will always over-allocate, since no\n// allocation is necessary\nlet vec_units = Vec::<()>::with_capacity(10);\nassert_eq!(vec_units.capacity(), usize::MAX);
\n
source

pub fn try_with_capacity(capacity: usize) -> Result<Vec<T>, TryReserveError>

🔬This is a nightly-only experimental API. (try_with_capacity)

Constructs a new, empty Vec<T> with at least the specified capacity.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n
§Errors
\n

Returns an error if the capacity exceeds isize::MAX bytes,\nor if the allocator reports allocation failure.

\n
1.0.0 · source

pub unsafe fn from_raw_parts(\n ptr: *mut T,\n length: usize,\n capacity: usize\n) -> Vec<T>

Creates a Vec<T> directly from a pointer, a length, and a capacity.

\n
§Safety
\n

This is highly unsafe, due to the number of invariants that aren’t\nchecked:

\n
    \n
  • ptr must have been allocated using the global allocator, such as via\nthe alloc::alloc function.
    • \n
  • T needs to have the same alignment as what ptr was allocated with.\n(T having a less strict alignment is not sufficient, the alignment really\nneeds to be equal to satisfy the dealloc requirement that memory must be\nallocated and deallocated with the same layout.)
    • \n
  • The size of T times the capacity (ie. the allocated size in bytes) needs\nto be the same size as the pointer was allocated with. (Because similar to\nalignment, dealloc must be called with the same layout size.)
    • \n
  • length needs to be less than or equal to capacity.
    • \n
  • The first length values must be properly initialized values of type T.
    • \n
  • capacity needs to be the capacity that the pointer was allocated with.
    • \n
  • The allocated size in bytes must be no larger than isize::MAX.\nSee the safety documentation of pointer::offset.
    • \n
\n

These requirements are always upheld by any ptr that has been allocated\nvia Vec<T>. Other allocation sources are allowed if the invariants are\nupheld.

\n

Violating these may cause problems like corrupting the allocator’s\ninternal data structures. For example it is normally not safe\nto build a Vec<u8> from a pointer to a C char array with length\nsize_t, doing so is only safe if the array was initially allocated by\na Vec or String.\nIt’s also not safe to build one from a Vec<u16> and its length, because\nthe allocator cares about the alignment, and these two types have different\nalignments. The buffer was allocated with alignment 2 (for u16), but after\nturning it into a Vec<u8> it’ll be deallocated with alignment 1. To avoid\nthese issues, it is often preferable to do casting/transmuting using\nslice::from_raw_parts instead.

\n

The ownership of ptr is effectively transferred to the\nVec<T> which may then deallocate, reallocate or change the\ncontents of memory pointed to by the pointer at will. Ensure\nthat nothing else uses the pointer after calling this\nfunction.

\n
§Examples
\n
use std::ptr;\nuse std::mem;\n\nlet v = vec![1, 2, 3];\n\n// Prevent running `v`'s destructor so we are in complete control\n// of the allocation.\nlet mut v = mem::ManuallyDrop::new(v);\n\n// Pull out the various important pieces of information about `v`\nlet p = v.as_mut_ptr();\nlet len = v.len();\nlet cap = v.capacity();\n\nunsafe {\n    // Overwrite memory with 4, 5, 6\n    for i in 0..len {\n        ptr::write(p.add(i), 4 + i);\n    }\n\n    // Put everything back together into a Vec\n    let rebuilt = Vec::from_raw_parts(p, len, cap);\n    assert_eq!(rebuilt, [4, 5, 6]);\n}
\n

Using memory that was allocated elsewhere:

\n\n
use std::alloc::{alloc, Layout};\n\nfn main() {\n    let layout = Layout::array::<u32>(16).expect(\"overflow cannot happen\");\n\n    let vec = unsafe {\n        let mem = alloc(layout).cast::<u32>();\n        if mem.is_null() {\n            return;\n        }\n\n        mem.write(1_000_000);\n\n        Vec::from_raw_parts(mem, 1, 16)\n    };\n\n    assert_eq!(vec, &[1_000_000]);\n    assert_eq!(vec.capacity(), 16);\n}
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n T: Clone,\n A: Allocator,

1.5.0 · source

pub fn resize(&mut self, new_len: usize, value: T)

Resizes the Vec in-place so that len is equal to new_len.

\n

If new_len is greater than len, the Vec is extended by the\ndifference, with each additional slot filled with value.\nIf new_len is less than len, the Vec is simply truncated.

\n

This method requires T to implement Clone,\nin order to be able to clone the passed value.\nIf you need more flexibility (or want to rely on Default instead of\nClone), use Vec::resize_with.\nIf you only need to resize to a smaller size, use Vec::truncate.

\n
§Examples
\n
let mut vec = vec![\"hello\"];\nvec.resize(3, \"world\");\nassert_eq!(vec, [\"hello\", \"world\", \"world\"]);\n\nlet mut vec = vec![1, 2, 3, 4];\nvec.resize(2, 0);\nassert_eq!(vec, [1, 2]);
\n
1.6.0 · source

pub fn extend_from_slice(&mut self, other: &[T])

Clones and appends all elements in a slice to the Vec.

\n

Iterates over the slice other, clones each element, and then appends\nit to this Vec. The other slice is traversed in-order.

\n

Note that this function is same as extend except that it is\nspecialized to work with slices instead. If and when Rust gets\nspecialization this function will likely be deprecated (but still\navailable).

\n
§Examples
\n
let mut vec = vec![1];\nvec.extend_from_slice(&[2, 3, 4]);\nassert_eq!(vec, [1, 2, 3, 4]);
\n
1.53.0 · source

pub fn extend_from_within<R>(&mut self, src: R)
where\n R: RangeBounds<usize>,

Copies elements from src range to the end of the vector.

\n
§Panics
\n

Panics if the starting point is greater than the end point or if\nthe end point is greater than the length of the vector.

\n
§Examples
\n
let mut vec = vec![0, 1, 2, 3, 4];\n\nvec.extend_from_within(2..);\nassert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4]);\n\nvec.extend_from_within(..2);\nassert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1]);\n\nvec.extend_from_within(4..8);\nassert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1, 4, 2, 3, 4]);
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n T: PartialEq,\n A: Allocator,

1.0.0 · source

pub fn dedup(&mut self)

Removes consecutive repeated elements in the vector according to the\nPartialEq trait implementation.

\n

If the vector is sorted, this removes all duplicates.

\n
§Examples
\n
let mut vec = vec![1, 2, 2, 3, 2];\n\nvec.dedup();\n\nassert_eq!(vec, [1, 2, 3, 2]);
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n A: Allocator,

1.21.0 · source

pub fn splice<R, I>(\n &mut self,\n range: R,\n replace_with: I\n) -> Splice<'_, <I as IntoIterator>::IntoIter, A>
where\n R: RangeBounds<usize>,\n I: IntoIterator<Item = T>,

Creates a splicing iterator that replaces the specified range in the vector\nwith the given replace_with iterator and yields the removed items.\nreplace_with does not need to be the same length as range.

\n

range is removed even if the iterator is not consumed until the end.

\n

It is unspecified how many elements are removed from the vector\nif the Splice value is leaked.

\n

The input iterator replace_with is only consumed when the Splice value is dropped.

\n

This is optimal if:

\n
    \n
  • The tail (elements in the vector after range) is empty,
    • \n
  • or replace_with yields fewer or equal elements than range’s length
    • \n
  • or the lower bound of its size_hint() is exact.
    • \n
\n

Otherwise, a temporary vector is allocated and the tail is moved twice.

\n
§Panics
\n

Panics if the starting point is greater than the end point or if\nthe end point is greater than the length of the vector.

\n
§Examples
\n
let mut v = vec![1, 2, 3, 4];\nlet new = [7, 8, 9];\nlet u: Vec<_> = v.splice(1..3, new).collect();\nassert_eq!(v, &[1, 7, 8, 9, 4]);\nassert_eq!(u, &[2, 3]);
\n
source

pub fn extract_if<F>(&mut self, filter: F) -> ExtractIf<'_, T, F, A>
where\n F: FnMut(&mut T) -> bool,

🔬This is a nightly-only experimental API. (extract_if)

Creates an iterator which uses a closure to determine if an element should be removed.

\n

If the closure returns true, then the element is removed and yielded.\nIf the closure returns false, the element will remain in the vector and will not be yielded\nby the iterator.

\n

If the returned ExtractIf is not exhausted, e.g. because it is dropped without iterating\nor the iteration short-circuits, then the remaining elements will be retained.\nUse retain with a negated predicate if you do not need the returned iterator.

\n

Using this method is equivalent to the following code:

\n\n
let mut i = 0;\nwhile i < vec.len() {\n    if some_predicate(&mut vec[i]) {\n        let val = vec.remove(i);\n        // your code here\n    } else {\n        i += 1;\n    }\n}\n
\n

But extract_if is easier to use. extract_if is also more efficient,\nbecause it can backshift the elements of the array in bulk.

\n

Note that extract_if also lets you mutate every element in the filter closure,\nregardless of whether you choose to keep or remove it.

\n
§Examples
\n

Splitting an array into evens and odds, reusing the original allocation:

\n\n
#![feature(extract_if)]\nlet mut numbers = vec![1, 2, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15];\n\nlet evens = numbers.extract_if(|x| *x % 2 == 0).collect::<Vec<_>>();\nlet odds = numbers;\n\nassert_eq!(evens, vec![2, 4, 6, 8, 14]);\nassert_eq!(odds, vec![1, 3, 5, 9, 11, 13, 15]);
\n
",0,"toml::value::Array"],["
source§

impl<T, A> Vec<T, A>
where\n A: Allocator,

source

pub const fn new_in(alloc: A) -> Vec<T, A>

🔬This is a nightly-only experimental API. (allocator_api)

Constructs a new, empty Vec<T, A>.

\n

The vector will not allocate until elements are pushed onto it.

\n
§Examples
\n
#![feature(allocator_api)]\n\nuse std::alloc::System;\n\nlet mut vec: Vec<i32, _> = Vec::new_in(System);
\n
source

pub fn with_capacity_in(capacity: usize, alloc: A) -> Vec<T, A>

🔬This is a nightly-only experimental API. (allocator_api)

Constructs a new, empty Vec<T, A> with at least the specified capacity\nwith the provided allocator.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n

It is important to note that although the returned vector has the\nminimum capacity specified, the vector will have a zero length. For\nan explanation of the difference between length and capacity, see\nCapacity and reallocation.

\n

If it is important to know the exact allocated capacity of a Vec,\nalways use the capacity method after construction.

\n

For Vec<T, A> where T is a zero-sized type, there will be no allocation\nand the capacity will always be usize::MAX.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
#![feature(allocator_api)]\n\nuse std::alloc::System;\n\nlet mut vec = Vec::with_capacity_in(10, System);\n\n// The vector contains no items, even though it has capacity for more\nassert_eq!(vec.len(), 0);\nassert!(vec.capacity() >= 10);\n\n// These are all done without reallocating...\nfor i in 0..10 {\n    vec.push(i);\n}\nassert_eq!(vec.len(), 10);\nassert!(vec.capacity() >= 10);\n\n// ...but this may make the vector reallocate\nvec.push(11);\nassert_eq!(vec.len(), 11);\nassert!(vec.capacity() >= 11);\n\n// A vector of a zero-sized type will always over-allocate, since no\n// allocation is necessary\nlet vec_units = Vec::<(), System>::with_capacity_in(10, System);\nassert_eq!(vec_units.capacity(), usize::MAX);
\n
source

pub fn try_with_capacity_in(\n capacity: usize,\n alloc: A\n) -> Result<Vec<T, A>, TryReserveError>

🔬This is a nightly-only experimental API. (allocator_api)

Constructs a new, empty Vec<T, A> with at least the specified capacity\nwith the provided allocator.

\n

The vector will be able to hold at least capacity elements without\nreallocating. This method is allowed to allocate for more elements than\ncapacity. If capacity is 0, the vector will not allocate.

\n
§Errors
\n

Returns an error if the capacity exceeds isize::MAX bytes,\nor if the allocator reports allocation failure.

\n
source

pub unsafe fn from_raw_parts_in(\n ptr: *mut T,\n length: usize,\n capacity: usize,\n alloc: A\n) -> Vec<T, A>

🔬This is a nightly-only experimental API. (allocator_api)

Creates a Vec<T, A> directly from a pointer, a length, a capacity,\nand an allocator.

\n
§Safety
\n

This is highly unsafe, due to the number of invariants that aren’t\nchecked:

\n
    \n
  • ptr must be currently allocated via the given allocator alloc.
    • \n
  • T needs to have the same alignment as what ptr was allocated with.\n(T having a less strict alignment is not sufficient, the alignment really\nneeds to be equal to satisfy the dealloc requirement that memory must be\nallocated and deallocated with the same layout.)
    • \n
  • The size of T times the capacity (ie. the allocated size in bytes) needs\nto be the same size as the pointer was allocated with. (Because similar to\nalignment, dealloc must be called with the same layout size.)
    • \n
  • length needs to be less than or equal to capacity.
    • \n
  • The first length values must be properly initialized values of type T.
    • \n
  • capacity needs to fit the layout size that the pointer was allocated with.
    • \n
  • The allocated size in bytes must be no larger than isize::MAX.\nSee the safety documentation of pointer::offset.
    • \n
\n

These requirements are always upheld by any ptr that has been allocated\nvia Vec<T, A>. Other allocation sources are allowed if the invariants are\nupheld.

\n

Violating these may cause problems like corrupting the allocator’s\ninternal data structures. For example it is not safe\nto build a Vec<u8> from a pointer to a C char array with length size_t.\nIt’s also not safe to build one from a Vec<u16> and its length, because\nthe allocator cares about the alignment, and these two types have different\nalignments. The buffer was allocated with alignment 2 (for u16), but after\nturning it into a Vec<u8> it’ll be deallocated with alignment 1.

\n

The ownership of ptr is effectively transferred to the\nVec<T> which may then deallocate, reallocate or change the\ncontents of memory pointed to by the pointer at will. Ensure\nthat nothing else uses the pointer after calling this\nfunction.

\n
§Examples
\n
#![feature(allocator_api)]\n\nuse std::alloc::System;\n\nuse std::ptr;\nuse std::mem;\n\nlet mut v = Vec::with_capacity_in(3, System);\nv.push(1);\nv.push(2);\nv.push(3);\n\n// Prevent running `v`'s destructor so we are in complete control\n// of the allocation.\nlet mut v = mem::ManuallyDrop::new(v);\n\n// Pull out the various important pieces of information about `v`\nlet p = v.as_mut_ptr();\nlet len = v.len();\nlet cap = v.capacity();\nlet alloc = v.allocator();\n\nunsafe {\n    // Overwrite memory with 4, 5, 6\n    for i in 0..len {\n        ptr::write(p.add(i), 4 + i);\n    }\n\n    // Put everything back together into a Vec\n    let rebuilt = Vec::from_raw_parts_in(p, len, cap, alloc.clone());\n    assert_eq!(rebuilt, [4, 5, 6]);\n}
\n

Using memory that was allocated elsewhere:

\n\n
#![feature(allocator_api)]\n\nuse std::alloc::{AllocError, Allocator, Global, Layout};\n\nfn main() {\n    let layout = Layout::array::<u32>(16).expect(\"overflow cannot happen\");\n\n    let vec = unsafe {\n        let mem = match Global.allocate(layout) {\n            Ok(mem) => mem.cast::<u32>().as_ptr(),\n            Err(AllocError) => return,\n        };\n\n        mem.write(1_000_000);\n\n        Vec::from_raw_parts_in(mem, 1, 16, Global)\n    };\n\n    assert_eq!(vec, &[1_000_000]);\n    assert_eq!(vec.capacity(), 16);\n}
\n
source

pub fn into_raw_parts(self) -> (*mut T, usize, usize)

🔬This is a nightly-only experimental API. (vec_into_raw_parts)

Decomposes a Vec<T> into its raw components: (pointer, length, capacity).

\n

Returns the raw pointer to the underlying data, the length of\nthe vector (in elements), and the allocated capacity of the\ndata (in elements). These are the same arguments in the same\norder as the arguments to from_raw_parts.

\n

After calling this function, the caller is responsible for the\nmemory previously managed by the Vec. The only way to do\nthis is to convert the raw pointer, length, and capacity back\ninto a Vec with the from_raw_parts function, allowing\nthe destructor to perform the cleanup.

\n
§Examples
\n
#![feature(vec_into_raw_parts)]\nlet v: Vec<i32> = vec![-1, 0, 1];\n\nlet (ptr, len, cap) = v.into_raw_parts();\n\nlet rebuilt = unsafe {\n    // We can now make changes to the components, such as\n    // transmuting the raw pointer to a compatible type.\n    let ptr = ptr as *mut u32;\n\n    Vec::from_raw_parts(ptr, len, cap)\n};\nassert_eq!(rebuilt, [4294967295, 0, 1]);
\n
source

pub fn into_raw_parts_with_alloc(self) -> (*mut T, usize, usize, A)

🔬This is a nightly-only experimental API. (allocator_api)

Decomposes a Vec<T> into its raw components: (pointer, length, capacity, allocator).

\n

Returns the raw pointer to the underlying data, the length of the vector (in elements),\nthe allocated capacity of the data (in elements), and the allocator. These are the same\narguments in the same order as the arguments to from_raw_parts_in.

\n

After calling this function, the caller is responsible for the\nmemory previously managed by the Vec. The only way to do\nthis is to convert the raw pointer, length, and capacity back\ninto a Vec with the from_raw_parts_in function, allowing\nthe destructor to perform the cleanup.

\n
§Examples
\n
#![feature(allocator_api, vec_into_raw_parts)]\n\nuse std::alloc::System;\n\nlet mut v: Vec<i32, System> = Vec::new_in(System);\nv.push(-1);\nv.push(0);\nv.push(1);\n\nlet (ptr, len, cap, alloc) = v.into_raw_parts_with_alloc();\n\nlet rebuilt = unsafe {\n    // We can now make changes to the components, such as\n    // transmuting the raw pointer to a compatible type.\n    let ptr = ptr as *mut u32;\n\n    Vec::from_raw_parts_in(ptr, len, cap, alloc)\n};\nassert_eq!(rebuilt, [4294967295, 0, 1]);
\n
1.0.0 · source

pub fn capacity(&self) -> usize

Returns the total number of elements the vector can hold without\nreallocating.

\n
§Examples
\n
let mut vec: Vec<i32> = Vec::with_capacity(10);\nvec.push(42);\nassert!(vec.capacity() >= 10);
\n
1.0.0 · source

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted\nin the given Vec<T>. The collection may reserve more space to\nspeculatively avoid frequent reallocations. After calling reserve,\ncapacity will be greater than or equal to self.len() + additional.\nDoes nothing if capacity is already sufficient.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1];\nvec.reserve(10);\nassert!(vec.capacity() >= 11);
\n
1.0.0 · source

pub fn reserve_exact(&mut self, additional: usize)

Reserves the minimum capacity for at least additional more elements to\nbe inserted in the given Vec<T>. Unlike reserve, this will not\ndeliberately over-allocate to speculatively avoid frequent allocations.\nAfter calling reserve_exact, capacity will be greater than or equal to\nself.len() + additional. Does nothing if the capacity is already\nsufficient.

\n

Note that the allocator may give the collection more space than it\nrequests. Therefore, capacity can not be relied upon to be precisely\nminimal. Prefer reserve if future insertions are expected.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1];\nvec.reserve_exact(10);\nassert!(vec.capacity() >= 11);
\n
1.57.0 · source

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Tries to reserve capacity for at least additional more elements to be inserted\nin the given Vec<T>. The collection may reserve more space to speculatively avoid\nfrequent reallocations. After calling try_reserve, capacity will be\ngreater than or equal to self.len() + additional if it returns\nOk(()). Does nothing if capacity is already sufficient. This method\npreserves the contents even if an error occurs.

\n
§Errors
\n

If the capacity overflows, or the allocator reports a failure, then an error\nis returned.

\n
§Examples
\n
use std::collections::TryReserveError;\n\nfn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {\n    let mut output = Vec::new();\n\n    // Pre-reserve the memory, exiting if we can't\n    output.try_reserve(data.len())?;\n\n    // Now we know this can't OOM in the middle of our complex work\n    output.extend(data.iter().map(|&val| {\n        val * 2 + 5 // very complicated\n    }));\n\n    Ok(output)\n}
\n
1.57.0 · source

pub fn try_reserve_exact(\n &mut self,\n additional: usize\n) -> Result<(), TryReserveError>

Tries to reserve the minimum capacity for at least additional\nelements to be inserted in the given Vec<T>. Unlike try_reserve,\nthis will not deliberately over-allocate to speculatively avoid frequent\nallocations. After calling try_reserve_exact, capacity will be greater\nthan or equal to self.len() + additional if it returns Ok(()).\nDoes nothing if the capacity is already sufficient.

\n

Note that the allocator may give the collection more space than it\nrequests. Therefore, capacity can not be relied upon to be precisely\nminimal. Prefer try_reserve if future insertions are expected.

\n
§Errors
\n

If the capacity overflows, or the allocator reports a failure, then an error\nis returned.

\n
§Examples
\n
use std::collections::TryReserveError;\n\nfn process_data(data: &[u32]) -> Result<Vec<u32>, TryReserveError> {\n    let mut output = Vec::new();\n\n    // Pre-reserve the memory, exiting if we can't\n    output.try_reserve_exact(data.len())?;\n\n    // Now we know this can't OOM in the middle of our complex work\n    output.extend(data.iter().map(|&val| {\n        val * 2 + 5 // very complicated\n    }));\n\n    Ok(output)\n}
\n
1.0.0 · source

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the vector as much as possible.

\n

The behavior of this method depends on the allocator, which may either shrink the vector\nin-place or reallocate. The resulting vector might still have some excess capacity, just as\nis the case for with_capacity. See Allocator::shrink for more details.

\n
§Examples
\n
let mut vec = Vec::with_capacity(10);\nvec.extend([1, 2, 3]);\nassert!(vec.capacity() >= 10);\nvec.shrink_to_fit();\nassert!(vec.capacity() >= 3);
\n
1.56.0 · source

pub fn shrink_to(&mut self, min_capacity: usize)

Shrinks the capacity of the vector with a lower bound.

\n

The capacity will remain at least as large as both the length\nand the supplied value.

\n

If the current capacity is less than the lower limit, this is a no-op.

\n
§Examples
\n
let mut vec = Vec::with_capacity(10);\nvec.extend([1, 2, 3]);\nassert!(vec.capacity() >= 10);\nvec.shrink_to(4);\nassert!(vec.capacity() >= 4);\nvec.shrink_to(0);\nassert!(vec.capacity() >= 3);
\n
1.0.0 · source

pub fn into_boxed_slice(self) -> Box<[T], A>

Converts the vector into Box<[T]>.

\n

Before doing the conversion, this method discards excess capacity like shrink_to_fit.

\n
§Examples
\n
let v = vec![1, 2, 3];\n\nlet slice = v.into_boxed_slice();
\n

Any excess capacity is removed:

\n\n
let mut vec = Vec::with_capacity(10);\nvec.extend([1, 2, 3]);\n\nassert!(vec.capacity() >= 10);\nlet slice = vec.into_boxed_slice();\nassert_eq!(slice.into_vec().capacity(), 3);
\n
1.0.0 · source

pub fn truncate(&mut self, len: usize)

Shortens the vector, keeping the first len elements and dropping\nthe rest.

\n

If len is greater or equal to the vector’s current length, this has\nno effect.

\n

The drain method can emulate truncate, but causes the excess\nelements to be returned instead of dropped.

\n

Note that this method has no effect on the allocated capacity\nof the vector.

\n
§Examples
\n

Truncating a five element vector to two elements:

\n\n
let mut vec = vec![1, 2, 3, 4, 5];\nvec.truncate(2);\nassert_eq!(vec, [1, 2]);
\n

No truncation occurs when len is greater than the vector’s current\nlength:

\n\n
let mut vec = vec![1, 2, 3];\nvec.truncate(8);\nassert_eq!(vec, [1, 2, 3]);
\n

Truncating when len == 0 is equivalent to calling the clear\nmethod.

\n\n
let mut vec = vec![1, 2, 3];\nvec.truncate(0);\nassert_eq!(vec, []);
\n
1.7.0 · source

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

\n

Equivalent to &s[..].

\n
§Examples
\n
use std::io::{self, Write};\nlet buffer = vec![1, 2, 3, 5, 8];\nio::sink().write(buffer.as_slice()).unwrap();
\n
1.7.0 · source

pub fn as_mut_slice(&mut self) -> &mut [T]

Extracts a mutable slice of the entire vector.

\n

Equivalent to &mut s[..].

\n
§Examples
\n
use std::io::{self, Read};\nlet mut buffer = vec![0; 3];\nio::repeat(0b101).read_exact(buffer.as_mut_slice()).unwrap();
\n
1.37.0 · source

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer, or a dangling raw pointer\nvalid for zero sized reads if the vector didn’t allocate.

\n

The caller must ensure that the vector outlives the pointer this\nfunction returns, or else it will end up pointing to garbage.\nModifying the vector may cause its buffer to be reallocated,\nwhich would also make any pointers to it invalid.

\n

The caller must also ensure that the memory the pointer (non-transitively) points to\nis never written to (except inside an UnsafeCell) using this pointer or any pointer\nderived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

\n

This method guarantees that for the purpose of the aliasing model, this method\ndoes not materialize a reference to the underlying slice, and thus the returned pointer\nwill remain valid when mixed with other calls to as_ptr and as_mut_ptr.\nNote that calling other methods that materialize mutable references to the slice,\nor mutable references to specific elements you are planning on accessing through this pointer,\nas well as writing to those elements, may still invalidate this pointer.\nSee the second example below for how this guarantee can be used.

\n
§Examples
\n
let x = vec![1, 2, 4];\nlet x_ptr = x.as_ptr();\n\nunsafe {\n    for i in 0..x.len() {\n        assert_eq!(*x_ptr.add(i), 1 << i);\n    }\n}
\n

Due to the aliasing guarantee, the following code is legal:

\n\n
unsafe {\n    let mut v = vec![0, 1, 2];\n    let ptr1 = v.as_ptr();\n    let _ = ptr1.read();\n    let ptr2 = v.as_mut_ptr().offset(2);\n    ptr2.write(2);\n    // Notably, the write to `ptr2` did *not* invalidate `ptr1`\n    // because it mutated a different element:\n    let _ = ptr1.read();\n}
\n
1.37.0 · source

pub fn as_mut_ptr(&mut self) -> *mut T

Returns an unsafe mutable pointer to the vector’s buffer, or a dangling\nraw pointer valid for zero sized reads if the vector didn’t allocate.

\n

The caller must ensure that the vector outlives the pointer this\nfunction returns, or else it will end up pointing to garbage.\nModifying the vector may cause its buffer to be reallocated,\nwhich would also make any pointers to it invalid.

\n

This method guarantees that for the purpose of the aliasing model, this method\ndoes not materialize a reference to the underlying slice, and thus the returned pointer\nwill remain valid when mixed with other calls to as_ptr and as_mut_ptr.\nNote that calling other methods that materialize references to the slice,\nor references to specific elements you are planning on accessing through this pointer,\nmay still invalidate this pointer.\nSee the second example below for how this guarantee can be used.

\n
§Examples
\n
// Allocate vector big enough for 4 elements.\nlet size = 4;\nlet mut x: Vec<i32> = Vec::with_capacity(size);\nlet x_ptr = x.as_mut_ptr();\n\n// Initialize elements via raw pointer writes, then set length.\nunsafe {\n    for i in 0..size {\n        *x_ptr.add(i) = i as i32;\n    }\n    x.set_len(size);\n}\nassert_eq!(&*x, &[0, 1, 2, 3]);
\n

Due to the aliasing guarantee, the following code is legal:

\n\n
unsafe {\n    let mut v = vec![0];\n    let ptr1 = v.as_mut_ptr();\n    ptr1.write(1);\n    let ptr2 = v.as_mut_ptr();\n    ptr2.write(2);\n    // Notably, the write to `ptr2` did *not* invalidate `ptr1`:\n    ptr1.write(3);\n}
\n
source

pub fn allocator(&self) -> &A

🔬This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

\n
1.0.0 · source

pub unsafe fn set_len(&mut self, new_len: usize)

Forces the length of the vector to new_len.

\n

This is a low-level operation that maintains none of the normal\ninvariants of the type. Normally changing the length of a vector\nis done using one of the safe operations instead, such as\ntruncate, resize, extend, or clear.

\n
§Safety
\n
    \n
  • new_len must be less than or equal to capacity().
    • \n
  • The elements at old_len..new_len must be initialized.
    • \n
\n
§Examples
\n

This method can be useful for situations in which the vector\nis serving as a buffer for other code, particularly over FFI:

\n\n
pub fn get_dictionary(&self) -> Option<Vec<u8>> {\n    // Per the FFI method's docs, \"32768 bytes is always enough\".\n    let mut dict = Vec::with_capacity(32_768);\n    let mut dict_length = 0;\n    // SAFETY: When `deflateGetDictionary` returns `Z_OK`, it holds that:\n    // 1. `dict_length` elements were initialized.\n    // 2. `dict_length` <= the capacity (32_768)\n    // which makes `set_len` safe to call.\n    unsafe {\n        // Make the FFI call...\n        let r = deflateGetDictionary(self.strm, dict.as_mut_ptr(), &mut dict_length);\n        if r == Z_OK {\n            // ...and update the length to what was initialized.\n            dict.set_len(dict_length);\n            Some(dict)\n        } else {\n            None\n        }\n    }\n}
\n

While the following example is sound, there is a memory leak since\nthe inner vectors were not freed prior to the set_len call:

\n\n
let mut vec = vec![vec![1, 0, 0],\n                   vec![0, 1, 0],\n                   vec![0, 0, 1]];\n// SAFETY:\n// 1. `old_len..0` is empty so no elements need to be initialized.\n// 2. `0 <= capacity` always holds whatever `capacity` is.\nunsafe {\n    vec.set_len(0);\n}
\n

Normally, here, one would use clear instead to correctly drop\nthe contents and thus not leak memory.

\n
1.0.0 · source

pub fn swap_remove(&mut self, index: usize) -> T

Removes an element from the vector and returns it.

\n

The removed element is replaced by the last element of the vector.

\n

This does not preserve ordering, but is O(1).\nIf you need to preserve the element order, use remove instead.

\n
§Panics
\n

Panics if index is out of bounds.

\n
§Examples
\n
let mut v = vec![\"foo\", \"bar\", \"baz\", \"qux\"];\n\nassert_eq!(v.swap_remove(1), \"bar\");\nassert_eq!(v, [\"foo\", \"qux\", \"baz\"]);\n\nassert_eq!(v.swap_remove(0), \"foo\");\nassert_eq!(v, [\"baz\", \"qux\"]);
\n
1.0.0 · source

pub fn insert(&mut self, index: usize, element: T)

Inserts an element at position index within the vector, shifting all\nelements after it to the right.

\n
§Panics
\n

Panics if index > len.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nvec.insert(1, 4);\nassert_eq!(vec, [1, 4, 2, 3]);\nvec.insert(4, 5);\nassert_eq!(vec, [1, 4, 2, 3, 5]);
\n
§Time complexity
\n

Takes O(Vec::len) time. All items after the insertion index must be\nshifted to the right. In the worst case, all elements are shifted when\nthe insertion index is 0.

\n
1.0.0 · source

pub fn remove(&mut self, index: usize) -> T

Removes and returns the element at position index within the vector,\nshifting all elements after it to the left.

\n

Note: Because this shifts over the remaining elements, it has a\nworst-case performance of O(n). If you don’t need the order of elements\nto be preserved, use swap_remove instead. If you’d like to remove\nelements from the beginning of the Vec, consider using\nVecDeque::pop_front instead.

\n
§Panics
\n

Panics if index is out of bounds.

\n
§Examples
\n
let mut v = vec![1, 2, 3];\nassert_eq!(v.remove(1), 2);\nassert_eq!(v, [1, 3]);
\n
1.0.0 · source

pub fn retain<F>(&mut self, f: F)
where\n F: FnMut(&T) -> bool,

Retains only the elements specified by the predicate.

\n

In other words, remove all elements e for which f(&e) returns false.\nThis method operates in place, visiting each element exactly once in the\noriginal order, and preserves the order of the retained elements.

\n
§Examples
\n
let mut vec = vec![1, 2, 3, 4];\nvec.retain(|&x| x % 2 == 0);\nassert_eq!(vec, [2, 4]);
\n

Because the elements are visited exactly once in the original order,\nexternal state may be used to decide which elements to keep.

\n\n
let mut vec = vec![1, 2, 3, 4, 5];\nlet keep = [false, true, true, false, true];\nlet mut iter = keep.iter();\nvec.retain(|_| *iter.next().unwrap());\nassert_eq!(vec, [2, 3, 5]);
\n
1.61.0 · source

pub fn retain_mut<F>(&mut self, f: F)
where\n F: FnMut(&mut T) -> bool,

Retains only the elements specified by the predicate, passing a mutable reference to it.

\n

In other words, remove all elements e such that f(&mut e) returns false.\nThis method operates in place, visiting each element exactly once in the\noriginal order, and preserves the order of the retained elements.

\n
§Examples
\n
let mut vec = vec![1, 2, 3, 4];\nvec.retain_mut(|x| if *x <= 3 {\n    *x += 1;\n    true\n} else {\n    false\n});\nassert_eq!(vec, [2, 3, 4]);
\n
1.16.0 · source

pub fn dedup_by_key<F, K>(&mut self, key: F)
where\n F: FnMut(&mut T) -> K,\n K: PartialEq,

Removes all but the first of consecutive elements in the vector that resolve to the same\nkey.

\n

If the vector is sorted, this removes all duplicates.

\n
§Examples
\n
let mut vec = vec![10, 20, 21, 30, 20];\n\nvec.dedup_by_key(|i| *i / 10);\n\nassert_eq!(vec, [10, 20, 30, 20]);
\n
1.16.0 · source

pub fn dedup_by<F>(&mut self, same_bucket: F)
where\n F: FnMut(&mut T, &mut T) -> bool,

Removes all but the first of consecutive elements in the vector satisfying a given equality\nrelation.

\n

The same_bucket function is passed references to two elements from the vector and\nmust determine if the elements compare equal. The elements are passed in opposite order\nfrom their order in the slice, so if same_bucket(a, b) returns true, a is removed.

\n

If the vector is sorted, this removes all duplicates.

\n
§Examples
\n
let mut vec = vec![\"foo\", \"bar\", \"Bar\", \"baz\", \"bar\"];\n\nvec.dedup_by(|a, b| a.eq_ignore_ascii_case(b));\n\nassert_eq!(vec, [\"foo\", \"bar\", \"baz\", \"bar\"]);
\n
1.0.0 · source

pub fn push(&mut self, value: T)

Appends an element to the back of a collection.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1, 2];\nvec.push(3);\nassert_eq!(vec, [1, 2, 3]);
\n
§Time complexity
\n

Takes amortized O(1) time. If the vector’s length would exceed its\ncapacity after the push, O(capacity) time is taken to copy the\nvector’s elements to a larger allocation. This expensive operation is\noffset by the capacity O(1) insertions it allows.

\n
source

pub fn push_within_capacity(&mut self, value: T) -> Result<(), T>

🔬This is a nightly-only experimental API. (vec_push_within_capacity)

Appends an element if there is sufficient spare capacity, otherwise an error is returned\nwith the element.

\n

Unlike push this method will not reallocate when there’s insufficient capacity.\nThe caller should use reserve or try_reserve to ensure that there is enough capacity.

\n
§Examples
\n

A manual, panic-free alternative to FromIterator:

\n\n
#![feature(vec_push_within_capacity)]\n\nuse std::collections::TryReserveError;\nfn from_iter_fallible<T>(iter: impl Iterator<Item=T>) -> Result<Vec<T>, TryReserveError> {\n    let mut vec = Vec::new();\n    for value in iter {\n        if let Err(value) = vec.push_within_capacity(value) {\n            vec.try_reserve(1)?;\n            // this cannot fail, the previous line either returned or added at least 1 free slot\n            let _ = vec.push_within_capacity(value);\n        }\n    }\n    Ok(vec)\n}\nassert_eq!(from_iter_fallible(0..100), Ok(Vec::from_iter(0..100)));
\n
§Time complexity
\n

Takes O(1) time.

\n
1.0.0 · source

pub fn pop(&mut self) -> Option<T>

Removes the last element from a vector and returns it, or None if it\nis empty.

\n

If you’d like to pop the first element, consider using\nVecDeque::pop_front instead.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nassert_eq!(vec.pop(), Some(3));\nassert_eq!(vec, [1, 2]);
\n
§Time complexity
\n

Takes O(1) time.

\n
1.4.0 · source

pub fn append(&mut self, other: &mut Vec<T, A>)

Moves all the elements of other into self, leaving other empty.

\n
§Panics
\n

Panics if the new capacity exceeds isize::MAX bytes.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nlet mut vec2 = vec![4, 5, 6];\nvec.append(&mut vec2);\nassert_eq!(vec, [1, 2, 3, 4, 5, 6]);\nassert_eq!(vec2, []);
\n
1.6.0 · source

pub fn drain<R>(&mut self, range: R) -> Drain<'_, T, A>
where\n R: RangeBounds<usize>,

Removes the specified range from the vector in bulk, returning all\nremoved elements as an iterator. If the iterator is dropped before\nbeing fully consumed, it drops the remaining removed elements.

\n

The returned iterator keeps a mutable borrow on the vector to optimize\nits implementation.

\n
§Panics
\n

Panics if the starting point is greater than the end point or if\nthe end point is greater than the length of the vector.

\n
§Leaking
\n

If the returned iterator goes out of scope without being dropped (due to\nmem::forget, for example), the vector may have lost and leaked\nelements arbitrarily, including elements outside the range.

\n
§Examples
\n
let mut v = vec![1, 2, 3];\nlet u: Vec<_> = v.drain(1..).collect();\nassert_eq!(v, &[1]);\nassert_eq!(u, &[2, 3]);\n\n// A full range clears the vector, like `clear()` does\nv.drain(..);\nassert_eq!(v, &[]);
\n
1.0.0 · source

pub fn clear(&mut self)

Clears the vector, removing all values.

\n

Note that this method has no effect on the allocated capacity\nof the vector.

\n
§Examples
\n
let mut v = vec![1, 2, 3];\n\nv.clear();\n\nassert!(v.is_empty());
\n
1.0.0 · source

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to\nas its ‘length’.

\n
§Examples
\n
let a = vec![1, 2, 3];\nassert_eq!(a.len(), 3);
\n
1.0.0 · source

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

\n
§Examples
\n
let mut v = Vec::new();\nassert!(v.is_empty());\n\nv.push(1);\nassert!(!v.is_empty());
\n
1.4.0 · source

pub fn split_off(&mut self, at: usize) -> Vec<T, A>
where\n A: Clone,

Splits the collection into two at the given index.

\n

Returns a newly allocated vector containing the elements in the range\n[at, len). After the call, the original vector will be left containing\nthe elements [0, at) with its previous capacity unchanged.

\n
    \n
  • If you want to take ownership of the entire contents and capacity of\nthe vector, see mem::take or mem::replace.
    • \n
  • If you don’t need the returned vector at all, see Vec::truncate.
    • \n
  • If you want to take ownership of an arbitrary subslice, or you don’t\nnecessarily want to store the removed items in a vector, see Vec::drain.
    • \n
\n
§Panics
\n

Panics if at > len.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nlet vec2 = vec.split_off(1);\nassert_eq!(vec, [1]);\nassert_eq!(vec2, [2, 3]);
\n
1.33.0 · source

pub fn resize_with<F>(&mut self, new_len: usize, f: F)
where\n F: FnMut() -> T,

Resizes the Vec in-place so that len is equal to new_len.

\n

If new_len is greater than len, the Vec is extended by the\ndifference, with each additional slot filled with the result of\ncalling the closure f. The return values from f will end up\nin the Vec in the order they have been generated.

\n

If new_len is less than len, the Vec is simply truncated.

\n

This method uses a closure to create new values on every push. If\nyou’d rather Clone a given value, use Vec::resize. If you\nwant to use the Default trait to generate values, you can\npass Default::default as the second argument.

\n
§Examples
\n
let mut vec = vec![1, 2, 3];\nvec.resize_with(5, Default::default);\nassert_eq!(vec, [1, 2, 3, 0, 0]);\n\nlet mut vec = vec![];\nlet mut p = 1;\nvec.resize_with(4, || { p *= 2; p });\nassert_eq!(vec, [2, 4, 8, 16]);
\n
1.47.0 · source

pub fn leak<'a>(self) -> &'a mut [T]
where\n A: 'a,

Consumes and leaks the Vec, returning a mutable reference to the contents,\n&'a mut [T]. Note that the type T must outlive the chosen lifetime\n'a. If the type has only static references, or none at all, then this\nmay be chosen to be 'static.

\n

As of Rust 1.57, this method does not reallocate or shrink the Vec,\nso the leaked allocation may include unused capacity that is not part\nof the returned slice.

\n

This function is mainly useful for data that lives for the remainder of\nthe program’s life. Dropping the returned reference will cause a memory\nleak.

\n
§Examples
\n

Simple usage:

\n\n
let x = vec![1, 2, 3];\nlet static_ref: &'static mut [usize] = x.leak();\nstatic_ref[0] += 1;\nassert_eq!(static_ref, &[2, 2, 3]);
\n
1.60.0 · source

pub fn spare_capacity_mut(&mut self) -> &mut [MaybeUninit<T>]

Returns the remaining spare capacity of the vector as a slice of\nMaybeUninit<T>.

\n

The returned slice can be used to fill the vector with data (e.g. by\nreading from a file) before marking the data as initialized using the\nset_len method.

\n
§Examples
\n
// Allocate vector big enough for 10 elements.\nlet mut v = Vec::with_capacity(10);\n\n// Fill in the first 3 elements.\nlet uninit = v.spare_capacity_mut();\nuninit[0].write(0);\nuninit[1].write(1);\nuninit[2].write(2);\n\n// Mark the first 3 elements of the vector as being initialized.\nunsafe {\n    v.set_len(3);\n}\n\nassert_eq!(&v, &[0, 1, 2]);
\n
source

pub fn split_at_spare_mut(&mut self) -> (&mut [T], &mut [MaybeUninit<T>])

🔬This is a nightly-only experimental API. (vec_split_at_spare)

Returns vector content as a slice of T, along with the remaining spare\ncapacity of the vector as a slice of MaybeUninit<T>.

\n

The returned spare capacity slice can be used to fill the vector with data\n(e.g. by reading from a file) before marking the data as initialized using\nthe set_len method.

\n

Note that this is a low-level API, which should be used with care for\noptimization purposes. If you need to append data to a Vec\nyou can use push, extend, extend_from_slice,\nextend_from_within, insert, append, resize or\nresize_with, depending on your exact needs.

\n
§Examples
\n
#![feature(vec_split_at_spare)]\n\nlet mut v = vec![1, 1, 2];\n\n// Reserve additional space big enough for 10 elements.\nv.reserve(10);\n\nlet (init, uninit) = v.split_at_spare_mut();\nlet sum = init.iter().copied().sum::<u32>();\n\n// Fill in the next 4 elements.\nuninit[0].write(sum);\nuninit[1].write(sum * 2);\nuninit[2].write(sum * 3);\nuninit[3].write(sum * 4);\n\n// Mark the 4 elements of the vector as being initialized.\nunsafe {\n    let len = v.len();\n    v.set_len(len + 4);\n}\n\nassert_eq!(&v, &[1, 1, 2, 4, 8, 12, 16]);
\n
",0,"toml::value::Array"],["
1.0.0 · source§

impl<T, A> Eq for Vec<T, A>
where\n T: Eq,\n A: Allocator,

","Eq","toml::value::Array"]] };if (window.register_type_impls) {window.register_type_impls(type_impls);} else {window.pending_type_impls = type_impls;}})() \ No newline at end of file diff --git a/type.impl/core/result/enum.Result.js b/type.impl/core/result/enum.Result.js index 03fbcb784..60a0aacb4 100644 --- a/type.impl/core/result/enum.Result.js +++ b/type.impl/core/result/enum.Result.js @@ -2,11 +2,11 @@ "anyhow":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","anyhow::Result"],["
source§

impl<T, E> Context<T, E> for Result<T, E>
where\n E: StdError + Send + Sync + 'static,

source§

fn context<C>(self, context: C) -> Result<T, Error>
where\n C: Display + Send + Sync + 'static,

Wrap the error value with additional context.
source§

fn with_context<C, F>(self, context: F) -> Result<T, Error>
where\n C: Display + Send + Sync + 'static,\n F: FnOnce() -> C,

Wrap the error value with additional context that is evaluated lazily\nonly once an error does occur.
","Context","anyhow::Result"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","anyhow::Result"],["
source§

impl From<&StreamResult> for Result<MZStatus, MZError>

source§

fn from(res: &StreamResult) -> Result<MZStatus, MZError>

Converts to this type from the input type.
","From<&StreamResult>","anyhow::Result"],["
source§

impl From<StreamResult> for Result<MZStatus, MZError>

source§

fn from(res: StreamResult) -> Result<MZStatus, MZError>

Converts to this type from the input type.
","From","anyhow::Result"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","anyhow::Result"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","anyhow::Result"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","anyhow::Result"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","anyhow::Result"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","anyhow::Result"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","anyhow::Result"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","anyhow::Result"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","anyhow::Result"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","anyhow::Result"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","anyhow::Result"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"anyhow::Result"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"anyhow::Result"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"anyhow::Result"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"anyhow::Result"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"anyhow::Result"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","anyhow::Result"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","anyhow::Result"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","anyhow::Result"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","anyhow::Result"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","anyhow::Result"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","anyhow::Result"]], "clap":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","clap::error::Result"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","clap::error::Result"],["
source§

impl From<&StreamResult> for Result<MZStatus, MZError>

source§

fn from(res: &StreamResult) -> Result<MZStatus, MZError>

Converts to this type from the input type.
","From<&StreamResult>","clap::error::Result"],["
source§

impl From<StreamResult> for Result<MZStatus, MZError>

source§

fn from(res: StreamResult) -> Result<MZStatus, MZError>

Converts to this type from the input type.
","From","clap::error::Result"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","clap::error::Result"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","clap::error::Result"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","clap::error::Result"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","clap::error::Result"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","clap::error::Result"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","clap::error::Result"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","clap::error::Result"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","clap::error::Result"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","clap::error::Result"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","clap::error::Result"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"clap::error::Result"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"clap::error::Result"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"clap::error::Result"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"clap::error::Result"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"clap::error::Result"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","clap::error::Result"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","clap::error::Result"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","clap::error::Result"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","clap::error::Result"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","clap::error::Result"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","clap::error::Result"]], "clap_builder":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","clap_builder::error::Result"],["
source§

impl From<&StreamResult> for Result<MZStatus, MZError>

source§

fn from(res: &StreamResult) -> Result<MZStatus, MZError>

Converts to this type from the input type.
","From<&StreamResult>","clap_builder::error::Result"],["
source§

impl From<StreamResult> for Result<MZStatus, MZError>

source§

fn from(res: StreamResult) -> Result<MZStatus, MZError>

Converts to this type from the input type.
","From","clap_builder::error::Result"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","clap_builder::error::Result"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","clap_builder::error::Result"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","clap_builder::error::Result"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","clap_builder::error::Result"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","clap_builder::error::Result"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"clap_builder::error::Result"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"clap_builder::error::Result"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"clap_builder::error::Result"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"clap_builder::error::Result"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"clap_builder::error::Result"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","clap_builder::error::Result"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","clap_builder::error::Result"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","clap_builder::error::Result"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","clap_builder::error::Result"]], -"edlang_parser":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","edlang_parser::lexer::Spanned"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","edlang_parser::lexer::Spanned"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","edlang_parser::lexer::Spanned"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","edlang_parser::lexer::Spanned"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"edlang_parser::lexer::Spanned"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","edlang_parser::lexer::Spanned"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","edlang_parser::lexer::Spanned"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","edlang_parser::lexer::Spanned"],["
source§

impl<'module_name> __ToTriple<'module_name> for Result<(usize, Token, usize), LexicalError>

source§

fn to_triple(\n value: Self\n) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>

","__ToTriple<'module_name>","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","edlang_parser::lexer::Spanned"]], +"edlang_parser":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","edlang_parser::lexer::Spanned"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","edlang_parser::lexer::Spanned"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","edlang_parser::lexer::Spanned"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","edlang_parser::lexer::Spanned"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"edlang_parser::lexer::Spanned"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","edlang_parser::lexer::Spanned"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","edlang_parser::lexer::Spanned"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","edlang_parser::lexer::Spanned"],["
source§

impl<'module_name> __ToTriple<'module_name> for Result<(usize, Token, usize), LexicalError>

source§

fn to_triple(\n value: Self\n) -> Result<(usize, Token, usize), ParseError<usize, Token, LexicalError>>

","__ToTriple<'module_name>","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","edlang_parser::lexer::Spanned"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","edlang_parser::lexer::Spanned"]], "lalrpop_util":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","lalrpop_util::state_machine::ParseResult"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"lalrpop_util::state_machine::ParseResult"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","lalrpop_util::state_machine::ParseResult"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","lalrpop_util::state_machine::ParseResult"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","lalrpop_util::state_machine::ParseResult"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","lalrpop_util::state_machine::ParseResult"]], "serde":[], "strsim":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","strsim::HammingResult"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","strsim::HammingResult"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","strsim::HammingResult"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","strsim::HammingResult"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","strsim::HammingResult"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"strsim::HammingResult"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","strsim::HammingResult"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","strsim::HammingResult"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","strsim::HammingResult"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","strsim::HammingResult"]], "syn":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","syn::error::Result"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","syn::error::Result"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","syn::error::Result"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","syn::error::Result"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","syn::error::Result"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","syn::error::Result"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","syn::error::Result"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","syn::error::Result"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","syn::error::Result"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","syn::error::Result"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","syn::error::Result"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","syn::error::Result"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"syn::error::Result"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"syn::error::Result"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"syn::error::Result"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"syn::error::Result"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"syn::error::Result"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","syn::error::Result"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","syn::error::Result"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","syn::error::Result"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","syn::error::Result"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","syn::error::Result"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","syn::error::Result"]], "walkdir":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","walkdir::Result"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","walkdir::Result"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","walkdir::Result"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","walkdir::Result"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","walkdir::Result"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","walkdir::Result"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","walkdir::Result"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","walkdir::Result"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","walkdir::Result"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","walkdir::Result"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","walkdir::Result"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","walkdir::Result"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"walkdir::Result"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"walkdir::Result"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"walkdir::Result"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"walkdir::Result"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"walkdir::Result"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","walkdir::Result"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","walkdir::Result"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","walkdir::Result"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","walkdir::Result"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","walkdir::Result"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","walkdir::Result"]], -"winnow":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","winnow::error::PResult"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","winnow::error::PResult"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","winnow::error::PResult"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T> ⓘ

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","winnow::error::PResult"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","winnow::error::PResult"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","winnow::error::PResult"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T> ⓘ

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T> ⓘ

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"winnow::error::PResult"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","winnow::error::PResult"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","winnow::error::PResult"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","winnow::error::PResult"]] +"winnow":[["
1.0.0 · source§

impl<T, E> Clone for Result<T, E>
where\n T: Clone,\n E: Clone,

source§

fn clone(&self) -> Result<T, E>

Returns a copy of the value. Read more
source§

fn clone_from(&mut self, source: &Result<T, E>)

Performs copy-assignment from source. Read more
","Clone","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Debug for Result<T, E>
where\n T: Debug,\n E: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
","Debug","winnow::error::PResult"],["
1.0.0 · source§

impl<A, E, V> FromIterator<Result<A, E>> for Result<V, E>
where\n V: FromIterator<A>,

source§

fn from_iter<I>(iter: I) -> Result<V, E>
where\n I: IntoIterator<Item = Result<A, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err occur, a\ncontainer with the values of each Result is returned.

\n

Here is an example which increments every integer in a vector,\nchecking for overflow:

\n\n
let v = vec![1, 2];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_add(1).ok_or(\"Overflow!\")\n).collect();\nassert_eq!(res, Ok(vec![2, 3]));
\n

Here is another example that tries to subtract one from another list\nof integers, this time checking for underflow:

\n\n
let v = vec![1, 2, 0];\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32|\n    x.checked_sub(1).ok_or(\"Underflow!\")\n).collect();\nassert_eq!(res, Err(\"Underflow!\"));
\n

Here is a variation on the previous example, showing that no\nfurther elements are taken from iter after the first Err.

\n\n
let v = vec![3, 2, 1, 10];\nlet mut shared = 0;\nlet res: Result<Vec<u32>, &'static str> = v.iter().map(|x: &u32| {\n    shared += x;\n    x.checked_sub(2).ok_or(\"Underflow!\")\n}).collect();\nassert_eq!(res, Err(\"Underflow!\"));\nassert_eq!(shared, 6);
\n

Since the third element caused an underflow, no further elements were taken,\nso the final value of shared is 6 (= 3 + 2 + 1), not 16.

\n
","FromIterator>","winnow::error::PResult"],["
source§

impl<T, E, F> FromResidual<Result<Infallible, E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(residual: Result<Infallible, E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","winnow::error::PResult"],["
source§

impl<T, E, F> FromResidual<Yeet<E>> for Result<T, F>
where\n F: From<E>,

source§

fn from_residual(_: Yeet<E>) -> Result<T, F>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from a compatible Residual type. Read more
","FromResidual>","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Hash for Result<T, E>
where\n T: Hash,\n E: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where\n __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where\n H: Hasher,\n Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
","Hash","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> IntoIterator for Result<T, E>

source§

fn into_iter(self) -> IntoIter<T>

Returns a consuming iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(5);\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, [5]);\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nlet v: Vec<u32> = x.into_iter().collect();\nassert_eq!(v, []);
\n
§

type Item = T

The type of the elements being iterated over.
§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
","IntoIterator","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Ord for Result<T, E>
where\n T: Ord,\n E: Ord,

source§

fn cmp(&self, other: &Result<T, E>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where\n Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where\n Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
","Ord","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> PartialEq for Result<T, E>
where\n T: PartialEq,\n E: PartialEq,

source§

fn eq(&self, other: &Result<T, E>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> PartialOrd for Result<T, E>
where\n T: PartialOrd,\n E: PartialOrd,

source§

fn partial_cmp(&self, other: &Result<T, E>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","winnow::error::PResult"],["
1.16.0 · source§

impl<T, U, E> Product<Result<U, E>> for Result<T, E>
where\n T: Product<U>,

source§

fn product<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the product of all elements is returned.

\n
§Examples
\n

This multiplies each number in a vector of strings,\nif a string could not be parsed the operation returns Err:

\n\n
let nums = vec![\"5\", \"10\", \"1\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert_eq!(total, Ok(100));\nlet nums = vec![\"5\", \"10\", \"one\", \"2\"];\nlet total: Result<usize, _> = nums.iter().map(|w| w.parse::<usize>()).product();\nassert!(total.is_err());
\n
","Product>","winnow::error::PResult"],["
source§

impl<T, E> Residual<T> for Result<Infallible, E>

§

type TryType = Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)
The “return” type of this meta-function.
","Residual","winnow::error::PResult"],["
source§

impl<T, E> Result<&T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let val = 12;\nlet x: Result<&i32, i32> = Ok(&val);\nassert_eq!(x, Ok(&12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<&mut T, E>

1.59.0 · source

pub fn copied(self) -> Result<T, E>
where\n T: Copy,

Maps a Result<&mut T, E> to a Result<T, E> by copying the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet copied = x.copied();\nassert_eq!(copied, Ok(12));
\n
1.59.0 · source

pub fn cloned(self) -> Result<T, E>
where\n T: Clone,

Maps a Result<&mut T, E> to a Result<T, E> by cloning the contents of the\nOk part.

\n
§Examples
\n
let mut val = 12;\nlet x: Result<&mut i32, i32> = Ok(&mut val);\nassert_eq!(x, Ok(&mut 12));\nlet cloned = x.cloned();\nassert_eq!(cloned, Ok(12));
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<Option<T>, E>

1.33.0 (const: unstable) · source

pub fn transpose(self) -> Option<Result<T, E>>

Transposes a Result of an Option into an Option of a Result.

\n

Ok(None) will be mapped to None.\nOk(Some(_)) and Err(_) will be mapped to Some(Ok(_)) and Some(Err(_)).

\n
§Examples
\n
#[derive(Debug, Eq, PartialEq)]\nstruct SomeErr;\n\nlet x: Result<Option<i32>, SomeErr> = Ok(Some(5));\nlet y: Option<Result<i32, SomeErr>> = Some(Ok(5));\nassert_eq!(x.transpose(), y);
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<Result<T, E>, E>

source

pub fn flatten(self) -> Result<T, E>

🔬This is a nightly-only experimental API. (result_flattening)

Converts from Result<Result<T, E>, E> to Result<T, E>

\n
§Examples
\n
#![feature(result_flattening)]\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Ok(\"hello\"));\nassert_eq!(Ok(\"hello\"), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));\nassert_eq!(Err(6), x.flatten());\n\nlet x: Result<Result<&'static str, u32>, u32> = Err(6);\nassert_eq!(Err(6), x.flatten());
\n

Flattening only removes one level of nesting at a time:

\n\n
#![feature(result_flattening)]\nlet x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok(\"hello\")));\nassert_eq!(Ok(Ok(\"hello\")), x.flatten());\nassert_eq!(Ok(\"hello\"), x.flatten().flatten());
\n
",0,"winnow::error::PResult"],["
source§

impl<T, E> Result<T, E>

1.0.0 (const: 1.48.0) · source

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_ok(), true);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_ok(), false);
\n
1.70.0 · source

pub fn is_ok_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Ok and the value inside of it matches a predicate.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.is_ok_and(|x| x > 1), true);\n\nlet x: Result<u32, &str> = Ok(0);\nassert_eq!(x.is_ok_and(|x| x > 1), false);\n\nlet x: Result<u32, &str> = Err(\"hey\");\nassert_eq!(x.is_ok_and(|x| x > 1), false);
\n
1.0.0 (const: 1.48.0) · source

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

\n
§Examples
\n
let x: Result<i32, &str> = Ok(-3);\nassert_eq!(x.is_err(), false);\n\nlet x: Result<i32, &str> = Err(\"Some error message\");\nassert_eq!(x.is_err(), true);
\n
1.70.0 · source

pub fn is_err_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Err and the value inside of it matches a predicate.

\n
§Examples
\n
use std::io::{Error, ErrorKind};\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::NotFound, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), true);\n\nlet x: Result<u32, Error> = Err(Error::new(ErrorKind::PermissionDenied, \"!\"));\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);\n\nlet x: Result<u32, Error> = Ok(123);\nassert_eq!(x.is_err_and(|x| x.kind() == ErrorKind::NotFound), false);
\n
1.0.0 · source

pub fn ok(self) -> Option<T>

Converts from Result<T, E> to Option<T>.

\n

Converts self into an Option<T>, consuming self,\nand discarding the error, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.ok(), Some(2));\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.ok(), None);
\n
1.0.0 · source

pub fn err(self) -> Option<E>

Converts from Result<T, E> to Option<E>.

\n

Converts self into an Option<E>, consuming self,\nand discarding the success value, if any.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.err(), None);\n\nlet x: Result<u32, &str> = Err(\"Nothing here\");\nassert_eq!(x.err(), Some(\"Nothing here\"));
\n
1.0.0 (const: 1.48.0) · source

pub const fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

\n

Produces a new Result, containing a reference\ninto the original, leaving the original in place.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.as_ref(), Ok(&2));\n\nlet x: Result<u32, &str> = Err(\"Error\");\nassert_eq!(x.as_ref(), Err(&\"Error\"));
\n
1.0.0 (const: unstable) · source

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut Result<T, E> to Result<&mut T, &mut E>.

\n
§Examples
\n
fn mutate(r: &mut Result<i32, i32>) {\n    match r.as_mut() {\n        Ok(v) => *v = 42,\n        Err(e) => *e = 0,\n    }\n}\n\nlet mut x: Result<i32, i32> = Ok(2);\nmutate(&mut x);\nassert_eq!(x.unwrap(), 42);\n\nlet mut x: Result<i32, i32> = Err(13);\nmutate(&mut x);\nassert_eq!(x.unwrap_err(), 0);
\n
1.0.0 · source

pub fn map<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> U,

Maps a Result<T, E> to Result<U, E> by applying a function to a\ncontained Ok value, leaving an Err value untouched.

\n

This function can be used to compose the results of two functions.

\n
§Examples
\n

Print the numbers on each line of a string multiplied by two.

\n\n
let line = \"1\\n2\\n3\\n4\\n\";\n\nfor num in line.lines() {\n    match num.parse::<i32>().map(|i| i * 2) {\n        Ok(n) => println!(\"{n}\"),\n        Err(..) => {}\n    }\n}
\n
1.41.0 · source

pub fn map_or<U, F>(self, default: U, f: F) -> U
where\n F: FnOnce(T) -> U,

Returns the provided default (if Err), or\napplies a function to the contained value (if Ok).

\n

Arguments passed to map_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use map_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let x: Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or(42, |v| v.len()), 3);\n\nlet x: Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or(42, |v| v.len()), 42);
\n
1.41.0 · source

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U
where\n D: FnOnce(E) -> U,\n F: FnOnce(T) -> U,

Maps a Result<T, E> to U by applying fallback function default to\na contained Err value, or function f to a contained Ok value.

\n

This function can be used to unpack a successful result\nwhile handling an error.

\n
§Examples
\n
let k = 21;\n\nlet x : Result<_, &str> = Ok(\"foo\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 3);\n\nlet x : Result<&str, _> = Err(\"bar\");\nassert_eq!(x.map_or_else(|e| k * 2, |v| v.len()), 42);
\n
1.0.0 · source

pub fn map_err<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> F,

Maps a Result<T, E> to Result<T, F> by applying a function to a\ncontained Err value, leaving an Ok value untouched.

\n

This function can be used to pass through a successful result while handling\nan error.

\n
§Examples
\n
fn stringify(x: u32) -> String { format!(\"error code: {x}\") }\n\nlet x: Result<u32, u32> = Ok(2);\nassert_eq!(x.map_err(stringify), Ok(2));\n\nlet x: Result<u32, u32> = Err(13);\nassert_eq!(x.map_err(stringify), Err(\"error code: 13\".to_string()));
\n
1.76.0 · source

pub fn inspect<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&T),

Calls a function with a reference to the contained value if Ok.

\n

Returns the original result.

\n
§Examples
\n
let x: u8 = \"4\"\n    .parse::<u8>()\n    .inspect(|x| println!(\"original: {x}\"))\n    .map(|x| x.pow(3))\n    .expect(\"failed to parse number\");
\n
1.76.0 · source

pub fn inspect_err<F>(self, f: F) -> Result<T, E>
where\n F: FnOnce(&E),

Calls a function with a reference to the contained value if Err.

\n

Returns the original result.

\n
§Examples
\n
use std::{fs, io};\n\nfn read() -> io::Result<String> {\n    fs::read_to_string(\"address.txt\")\n        .inspect_err(|e| eprintln!(\"failed to read file: {e}\"))\n}
\n
1.47.0 · source

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>
where\n T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

\n

Coerces the Ok variant of the original Result via Deref\nand returns the new Result.

\n
§Examples
\n
let x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&str, &u32> = Ok(\"hello\");\nassert_eq!(x.as_deref(), y);\n\nlet x: Result<String, u32> = Err(42);\nlet y: Result<&str, &u32> = Err(&42);\nassert_eq!(x.as_deref(), y);
\n
1.47.0 · source

pub fn as_deref_mut(&mut self) -> Result<&mut <T as Deref>::Target, &mut E>
where\n T: DerefMut,

Converts from Result<T, E> (or &mut Result<T, E>) to Result<&mut <T as DerefMut>::Target, &mut E>.

\n

Coerces the Ok variant of the original Result via DerefMut\nand returns the new Result.

\n
§Examples
\n
let mut s = \"HELLO\".to_string();\nlet mut x: Result<String, u32> = Ok(\"hello\".to_string());\nlet y: Result<&mut str, &mut u32> = Ok(&mut s);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);\n\nlet mut i = 42;\nlet mut x: Result<String, u32> = Err(42);\nlet y: Result<&mut str, &mut u32> = Err(&mut i);\nassert_eq!(x.as_deref_mut().map(|x| { x.make_ascii_uppercase(); x }), y);
\n
1.0.0 · source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(7);\nassert_eq!(x.iter().next(), Some(&7));\n\nlet x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter().next(), None);
\n
1.0.0 · source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

\n

The iterator yields one value if the result is Result::Ok, otherwise none.

\n
§Examples
\n
let mut x: Result<u32, &str> = Ok(7);\nmatch x.iter_mut().next() {\n    Some(v) => *v = 40,\n    None => {},\n}\nassert_eq!(x, Ok(40));\n\nlet mut x: Result<u32, &str> = Err(\"nothing!\");\nassert_eq!(x.iter_mut().next(), None);
\n
1.4.0 · source

pub fn expect(self, msg: &str) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message including the\npassed message, and the content of the Err.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.expect(\"Testing expect\"); // panics with `Testing expect: emergency failure`
\n
§Recommended Message Style
\n

We recommend that expect messages are used to describe the reason you\nexpect the Result should be Ok.

\n\n
ⓘ
let path = std::env::var(\"IMPORTANT_PATH\")\n    .expect(\"env variable `IMPORTANT_PATH` should be set by `wrapper_script.sh`\");
\n

Hint: If you’re having trouble remembering how to phrase expect\nerror messages remember to focus on the word “should” as in “env\nvariable should be set by blah” or “the given binary should be available\nand executable by the current user”.

\n

For more detail on expect message styles and the reasoning behind our recommendation please\nrefer to the section on “Common Message\nStyles” in the\nstd::error module docs.

\n
1.0.0 · source

pub fn unwrap(self) -> T
where\n E: Debug,

Returns the contained Ok value, consuming the self value.

\n

Because this function may panic, its use is generally discouraged.\nInstead, prefer to use pattern matching and handle the Err\ncase explicitly, or call unwrap_or, unwrap_or_else, or\nunwrap_or_default.

\n
§Panics
\n

Panics if the value is an Err, with a panic message provided by the\nErr’s value.

\n
§Examples
\n

Basic usage:

\n\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(x.unwrap(), 2);
\n\n
ⓘ
let x: Result<u32, &str> = Err(\"emergency failure\");\nx.unwrap(); // panics with `emergency failure`
\n
1.16.0 · source

pub fn unwrap_or_default(self) -> T
where\n T: Default,

Returns the contained Ok value or a default

\n

Consumes the self argument then, if Ok, returns the contained\nvalue, otherwise if Err, returns the default value for that\ntype.

\n
§Examples
\n

Converts a string to an integer, turning poorly-formed strings\ninto 0 (the default value for integers). parse converts\na string to any other type that implements FromStr, returning an\nErr on error.

\n\n
let good_year_from_input = \"1909\";\nlet bad_year_from_input = \"190blarg\";\nlet good_year = good_year_from_input.parse().unwrap_or_default();\nlet bad_year = bad_year_from_input.parse().unwrap_or_default();\n\nassert_eq!(1909, good_year);\nassert_eq!(0, bad_year);
\n
1.17.0 · source

pub fn expect_err(self, msg: &str) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a panic message including the\npassed message, and the content of the Ok.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(10);\nx.expect_err(\"Testing expect_err\"); // panics with `Testing expect_err: 10`
\n
1.0.0 · source

pub fn unwrap_err(self) -> E
where\n T: Debug,

Returns the contained Err value, consuming the self value.

\n
§Panics
\n

Panics if the value is an Ok, with a custom panic message provided\nby the Ok’s value.

\n
§Examples
\n
ⓘ
let x: Result<u32, &str> = Ok(2);\nx.unwrap_err(); // panics with `2`
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(x.unwrap_err(), \"emergency failure\");
\n
source

pub fn into_ok(self) -> T
where\n E: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Ok value, but never panics.

\n

Unlike unwrap, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap as a maintainability safeguard that will fail\nto compile if the error type of the Result is later changed\nto an error that can actually occur.

\n
§Examples
\n
\nfn only_good_news() -> Result<String, !> {\n    Ok(\"this is fine\".into())\n}\n\nlet s: String = only_good_news().into_ok();\nprintln!(\"{s}\");
\n
source

pub fn into_err(self) -> E
where\n T: Into<!>,

🔬This is a nightly-only experimental API. (unwrap_infallible)

Returns the contained Err value, but never panics.

\n

Unlike unwrap_err, this method is known to never panic on the\nresult types it is implemented for. Therefore, it can be used\ninstead of unwrap_err as a maintainability safeguard that will fail\nto compile if the ok type of the Result is later changed\nto a type that can actually occur.

\n
§Examples
\n
\nfn only_bad_news() -> Result<!, String> {\n    Err(\"Oops, it failed\".into())\n}\n\nlet error: String = only_bad_news().into_err();\nprintln!(\"{error}\");
\n
1.0.0 · source

pub fn and<U>(self, res: Result<U, E>) -> Result<U, E>

Returns res if the result is Ok, otherwise returns the Err value of self.

\n

Arguments passed to and are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use and_then, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<&str, &str> = Ok(\"foo\");\nassert_eq!(x.and(y), Err(\"early error\"));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<&str, &str> = Err(\"late error\");\nassert_eq!(x.and(y), Err(\"not a 2\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<&str, &str> = Ok(\"different result type\");\nassert_eq!(x.and(y), Ok(\"different result type\"));
\n
1.0.0 · source

pub fn and_then<U, F>(self, op: F) -> Result<U, E>
where\n F: FnOnce(T) -> Result<U, E>,

Calls op if the result is Ok, otherwise returns the Err value of self.

\n

This function can be used for control flow based on Result values.

\n
§Examples
\n
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {\n    x.checked_mul(x).map(|sq| sq.to_string()).ok_or(\"overflowed\")\n}\n\nassert_eq!(Ok(2).and_then(sq_then_to_string), Ok(4.to_string()));\nassert_eq!(Ok(1_000_000).and_then(sq_then_to_string), Err(\"overflowed\"));\nassert_eq!(Err(\"not a number\").and_then(sq_then_to_string), Err(\"not a number\"));
\n

Often used to chain fallible operations that may return Err.

\n\n
use std::{io::ErrorKind, path::Path};\n\n// Note: on Windows \"/\" maps to \"C:\\\"\nlet root_modified_time = Path::new(\"/\").metadata().and_then(|md| md.modified());\nassert!(root_modified_time.is_ok());\n\nlet should_fail = Path::new(\"/bad/path\").metadata().and_then(|md| md.modified());\nassert!(should_fail.is_err());\nassert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
\n
1.0.0 · source

pub fn or<F>(self, res: Result<T, F>) -> Result<T, F>

Returns res if the result is Err, otherwise returns the Ok value of self.

\n

Arguments passed to or are eagerly evaluated; if you are passing the\nresult of a function call, it is recommended to use or_else, which is\nlazily evaluated.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"early error\");\nlet y: Result<u32, &str> = Ok(2);\nassert_eq!(x.or(y), Ok(2));\n\nlet x: Result<u32, &str> = Err(\"not a 2\");\nlet y: Result<u32, &str> = Err(\"late error\");\nassert_eq!(x.or(y), Err(\"late error\"));\n\nlet x: Result<u32, &str> = Ok(2);\nlet y: Result<u32, &str> = Ok(100);\nassert_eq!(x.or(y), Ok(2));
\n
1.0.0 · source

pub fn or_else<F, O>(self, op: O) -> Result<T, F>
where\n O: FnOnce(E) -> Result<T, F>,

Calls op if the result is Err, otherwise returns the Ok value of self.

\n

This function can be used for control flow based on result values.

\n
§Examples
\n
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }\nfn err(x: u32) -> Result<u32, u32> { Err(x) }\n\nassert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));\nassert_eq!(Ok(2).or_else(err).or_else(sq), Ok(2));\nassert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));\nassert_eq!(Err(3).or_else(err).or_else(err), Err(3));
\n
1.0.0 · source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Ok value or a provided default.

\n

Arguments passed to unwrap_or are eagerly evaluated; if you are passing\nthe result of a function call, it is recommended to use unwrap_or_else,\nwhich is lazily evaluated.

\n
§Examples
\n
let default = 2;\nlet x: Result<u32, &str> = Ok(9);\nassert_eq!(x.unwrap_or(default), 9);\n\nlet x: Result<u32, &str> = Err(\"error\");\nassert_eq!(x.unwrap_or(default), default);
\n
1.0.0 · source

pub fn unwrap_or_else<F>(self, op: F) -> T
where\n F: FnOnce(E) -> T,

Returns the contained Ok value or computes it from a closure.

\n
§Examples
\n
fn count(x: &str) -> usize { x.len() }\n\nassert_eq!(Ok(2).unwrap_or_else(count), 2);\nassert_eq!(Err(\"foo\").unwrap_or_else(count), 3);
\n
1.58.0 · source

pub unsafe fn unwrap_unchecked(self) -> T

Returns the contained Ok value, consuming the self value,\nwithout checking that the value is not an Err.

\n
§Safety
\n

Calling this method on an Err is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nassert_eq!(unsafe { x.unwrap_unchecked() }, 2);
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nunsafe { x.unwrap_unchecked(); } // Undefined behavior!
\n
1.58.0 · source

pub unsafe fn unwrap_err_unchecked(self) -> E

Returns the contained Err value, consuming the self value,\nwithout checking that the value is not an Ok.

\n
§Safety
\n

Calling this method on an Ok is undefined behavior.

\n
§Examples
\n
let x: Result<u32, &str> = Ok(2);\nunsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
\n\n
let x: Result<u32, &str> = Err(\"emergency failure\");\nassert_eq!(unsafe { x.unwrap_err_unchecked() }, \"emergency failure\");
\n
",0,"winnow::error::PResult"],["
1.16.0 · source§

impl<T, U, E> Sum<Result<U, E>> for Result<T, E>
where\n T: Sum<U>,

source§

fn sum<I>(iter: I) -> Result<T, E>
where\n I: Iterator<Item = Result<U, E>>,

Takes each element in the Iterator: if it is an Err, no further\nelements are taken, and the Err is returned. Should no Err\noccur, the sum of all elements is returned.

\n
§Examples
\n

This sums up every integer in a vector, rejecting the sum if a negative\nelement is encountered:

\n\n
let f = |&x: &i32| if x < 0 { Err(\"Negative element found\") } else { Ok(x) };\nlet v = vec![1, 2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Ok(3));\nlet v = vec![1, -2];\nlet res: Result<i32, _> = v.iter().map(f).sum();\nassert_eq!(res, Err(\"Negative element found\"));
\n
","Sum>","winnow::error::PResult"],["
1.61.0 · source§

impl<T, E> Termination for Result<T, E>
where\n T: Termination,\n E: Debug,

source§

fn report(self) -> ExitCode

Is called to get the representation of the value as status code.\nThis status code is returned to the operating system.
","Termination","winnow::error::PResult"],["
source§

impl<T, E> Try for Result<T, E>

§

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value produced by ? when not short-circuiting.
§

type Residual = Result<Infallible, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
The type of the value passed to FromResidual::from_residual\nas part of ? when short-circuiting. Read more
source§

fn from_output(output: <Result<T, E> as Try>::Output) -> Result<T, E>

🔬This is a nightly-only experimental API. (try_trait_v2)
Constructs the type from its Output type. Read more
source§

fn branch(\n self\n) -> ControlFlow<<Result<T, E> as Try>::Residual, <Result<T, E> as Try>::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)
Used in ? to decide whether the operator should produce a value\n(because this returned ControlFlow::Continue)\nor propagate a value back to the caller\n(because this returned ControlFlow::Break). Read more
","Try","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Copy for Result<T, E>
where\n T: Copy,\n E: Copy,

","Copy","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> Eq for Result<T, E>
where\n T: Eq,\n E: Eq,

","Eq","winnow::error::PResult"],["
1.0.0 · source§

impl<T, E> StructuralPartialEq for Result<T, E>

","StructuralPartialEq","winnow::error::PResult"]] };if (window.register_type_impls) {window.register_type_impls(type_impls);} else {window.pending_type_impls = type_impls;}})() \ No newline at end of file diff --git a/type.impl/std/primitive.str.js b/type.impl/std/primitive.str.js index 87abfcac0..66a52ae92 100644 --- a/type.impl/std/primitive.str.js +++ b/type.impl/std/primitive.str.js @@ -1,3 +1,3 @@ (function() {var type_impls = { -"winnow":[["
source§

impl<'a> AsBStr for &'a str

source§

fn as_bstr(&self) -> &[u8] ⓘ

Casts the input type to a byte slice
","AsBStr","winnow::stream::Str"],["
source§

impl<'a, 'b> Compare<&'b str> for &'a str

source§

fn compare(&self, t: &'b str) -> CompareResult

Compares self to another value for equality
","Compare<&'b str>","winnow::stream::Str"],["
source§

impl<'a, 'b> Compare<Caseless<&'b str>> for &'a str

source§

fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult

Compares self to another value for equality
","Compare>","winnow::stream::Str"],["
source§

impl<'a> Compare<Caseless<char>> for &'a str

source§

fn compare(&self, t: AsciiCaseless<char>) -> CompareResult

Compares self to another value for equality
","Compare>","winnow::stream::Str"],["
source§

impl<'a> Compare<char> for &'a str

source§

fn compare(&self, t: char) -> CompareResult

Compares self to another value for equality
","Compare","winnow::stream::Str"],["
1.0.0 · source§

impl Default for &str

source§

fn default() -> &str

Creates an empty str

\n
","Default","winnow::stream::Str"],["
1.0.0 · source§

impl !Error for &str

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
","Error","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<&'s str> for &'i str

source§

fn find_slice(&self, substr: &'s str) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<&'s str>","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<(&'s str,)> for &'i str

source§

fn find_slice(&self, substr: (&'s str,)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(&'s str,)>","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i str

source§

fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(&'s str, &'s str)>","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i str

source§

fn find_slice(\n &self,\n substr: (&'s str, &'s str, &'s str)\n) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(&'s str, &'s str, &'s str)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<(char,)> for &'i str

source§

fn find_slice(&self, substr: (char,)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(char,)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<(char, char)> for &'i str

source§

fn find_slice(&self, substr: (char, char)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(char, char)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<(char, char, char)> for &'i str

source§

fn find_slice(&self, substr: (char, char, char)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(char, char, char)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<char> for &'i str

source§

fn find_slice(&self, substr: char) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice","winnow::stream::Str"],["
source§

impl<'a> Offset<<&'a str as Stream>::Checkpoint> for &'a str

source§

fn offset_from(&self, other: &<&'a str as Stream>::Checkpoint) -> usize

Offset between the first byte of start and the first byte of selfa Read more
","Offset<<&'a str as Stream>::Checkpoint>","winnow::stream::Str"],["
source§

impl<'a> Offset for &'a str

source§

fn offset_from(&self, start: &Self) -> usize

Offset between the first byte of start and the first byte of selfa Read more
","Offset","winnow::stream::Str"],["
source§

impl<'a, R: FromStr> ParseSlice<R> for &'a str

source§

fn parse_slice(&self) -> Option<R>

Succeeds if parse() succeeded Read more
","ParseSlice","winnow::stream::Str"],["
source§

impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s str
where\n I: Compare<&'s str> + StreamIsPartial + Stream,

This is a shortcut for literal.

\n

§Example

\n
\nfn parser<'s>(s: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {\n  alt((\"Hello\", take(5usize))).parse_next(s)\n}\n\nassert_eq!(parser.parse_peek(\"Hello, World!\"), Ok((\", World!\", \"Hello\")));\nassert_eq!(parser.parse_peek(\"Something\"), Ok((\"hing\", \"Somet\")));\nassert_eq!(parser.parse_peek(\"Some\"), Err(ErrMode::Backtrack(InputError::new(\"Some\", ErrorKind::Slice))));\nassert_eq!(parser.parse_peek(\"\"), Err(ErrMode::Backtrack(InputError::new(\"\", ErrorKind::Slice))));
\n
source§

fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

Take tokens from the Stream, turning it into the output Read more
source§

fn parse_peek(&mut self, input: I) -> IResult<I, O, E>

Take tokens from the Stream, turning it into the output Read more
source§

fn by_ref(&mut self) -> ByRef<'_, Self>
where\n Self: Sized,

Treat &mut Self as a parser Read more
source§

fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
where\n Self: Sized,\n O2: Clone,

Produce the provided value Read more
source§

fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
where\n Self: Sized,\n O2: Default,

Produce a type’s default value Read more
source§

fn void(self) -> Void<Self, I, O, E>
where\n Self: Sized,

Discards the output of the Parser Read more
source§

fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
where\n Self: Sized,\n O: Into<O2>,

Convert the parser’s output to another type using std::convert::From Read more
source§

fn recognize(self) -> Recognize<Self, I, O, E>
where\n Self: Sized,\n I: Stream,

Produce the consumed input as produced value. Read more
source§

fn with_recognized(self) -> WithRecognized<Self, I, O, E>
where\n Self: Sized,\n I: Stream,

Produce the consumed input with the output Read more
source§

fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
where\n G: FnMut(O) -> O2,\n Self: Sized,

Maps a function over the output of a parser Read more
source§

fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
where\n Self: Sized,\n G: FnMut(O) -> Result<O2, E2>,\n I: Stream,\n E: FromExternalError<I, E2>,

Applies a function returning a Result over the output of a parser. Read more
source§

fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
where\n Self: Sized,\n G: FnMut(O) -> Option<O2>,\n I: Stream,\n E: ParserError<I>,

Apply both Parser::verify and Parser::map. Read more
source§

fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
where\n Self: Sized,\n G: FnMut(O) -> H,\n H: Parser<I, O2, E>,

Creates a parser from the output of this one Read more
source§

fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
where\n Self: Sized,\n I: Stream,\n O: ParseSlice<O2>,\n E: ParserError<I>,

Apply std::str::FromStr to the output of the parser Read more
source§

fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
where\n Self: Sized,\n G: FnMut(&O2) -> bool,\n I: Stream,\n O: Borrow<O2>,\n O2: ?Sized,\n E: ParserError<I>,

Returns the output of the child parser if it satisfies a verification function. Read more
source§

fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
where\n Self: Sized,\n I: Stream,\n E: AddContext<I, C>,\n C: Clone + Debug,

If parsing fails, add context to the error Read more
source§

fn complete_err(self) -> CompleteErr<Self>
where\n Self: Sized,

Transforms Incomplete into Backtrack Read more
source§

fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
where\n Self: Sized,\n E: Into<E2>,

Convert the parser’s error to another type using std::convert::From
","Parser::Slice, E>","winnow::stream::Str"],["
source§

impl<'a, 'b> PartialEq<BStr> for &'a str

source§

fn eq(&self, other: &BStr) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
source§

impl<'a, 'b> PartialEq<Bytes> for &'a str

source§

fn eq(&self, other: &Bytes) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
1.0.0 · source§

impl<'a, 'b> PartialEq<Cow<'a, str>> for &'b str

source§

fn eq(&self, other: &Cow<'a, str>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &Cow<'a, str>) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq>","winnow::stream::Str"],["
1.29.0 · source§

impl<'a> PartialEq<OsString> for &'a str

source§

fn eq(&self, other: &OsString) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
1.0.0 · source§

impl<'a, 'b> PartialEq<String> for &'a str

source§

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &String) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
source§

impl<'a, 'b> PartialOrd<BStr> for &'a str

source§

fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","winnow::stream::Str"],["
source§

impl<'a, 'b> PartialOrd<Bytes> for &'a str

source§

fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","winnow::stream::Str"],["
source§

impl<'a, 'b> Pattern<'a> for &'b str

Non-allocating substring search.

\n

Will handle the pattern "" as returning empty matches at each character\nboundary.

\n

§Examples

\n
assert_eq!(\"Hello world\".find(\"world\"), Some(6));
\n
source§

fn is_prefix_of(self, haystack: &'a str) -> bool

🔬This is a nightly-only experimental API. (pattern)

Checks whether the pattern matches at the front of the haystack.

\n
source§

fn is_contained_in(self, haystack: &'a str) -> bool

🔬This is a nightly-only experimental API. (pattern)

Checks whether the pattern matches anywhere in the haystack

\n
source§

fn strip_prefix_of(self, haystack: &'a str) -> Option<&'a str>

🔬This is a nightly-only experimental API. (pattern)

Removes the pattern from the front of haystack, if it matches.

\n
source§

fn is_suffix_of(self, haystack: &'a str) -> bool

🔬This is a nightly-only experimental API. (pattern)

Checks whether the pattern matches at the back of the haystack.

\n
source§

fn strip_suffix_of(self, haystack: &'a str) -> Option<&'a str>

🔬This is a nightly-only experimental API. (pattern)

Removes the pattern from the back of haystack, if it matches.

\n
§

type Searcher = StrSearcher<'a, 'b>

🔬This is a nightly-only experimental API. (pattern)
Associated searcher for this pattern
source§

fn into_searcher(self, haystack: &'a str) -> StrSearcher<'a, 'b>

🔬This is a nightly-only experimental API. (pattern)
Constructs the associated searcher from\nself and the haystack to search in.
","Pattern<'a>","winnow::stream::Str"],["
source§

impl<'a> SliceLen for &'a str

source§

fn slice_len(&self) -> usize

Calculates the input length, as indicated by its name,\nand the name of the trait itself
","SliceLen","winnow::stream::Str"],["
source§

impl<'i> Stream for &'i str

§

type Token = char

The smallest unit being parsed Read more
§

type Slice = &'i str

Sequence of Tokens Read more
§

type IterOffsets = CharIndices<'i>

Iterate with the offset from the current location
§

type Checkpoint = Checkpoint<&'i str, &'i str>

A parse location within the stream
source§

fn iter_offsets(&self) -> Self::IterOffsets

Iterate with the offset from the current location
source§

fn eof_offset(&self) -> usize

Returns the offset to the end of the input
source§

fn next_token(&mut self) -> Option<Self::Token>

Split off the next token from the input
source§

fn offset_for<P>(&self, predicate: P) -> Option<usize>
where\n P: Fn(Self::Token) -> bool,

Finds the offset of the next matching token
source§

fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

Get the offset for the number of tokens into the stream Read more
source§

fn next_slice(&mut self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input Read more
source§

fn checkpoint(&self) -> Self::Checkpoint

Save the current parse location within the stream
source§

fn reset(&mut self, checkpoint: &Self::Checkpoint)

Revert the stream to a prior Self::Checkpoint Read more
source§

fn raw(&self) -> &dyn Debug

Return the inner-most stream
source§

fn peek_token(&self) -> Option<(Self, Self::Token)>
where\n Self: Clone,

Split off the next token from the input
source§

fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
where\n Self: Clone,

Split off a slice of tokens from the input
source§

fn finish(&mut self) -> Self::Slice

Advance to the end of the stream
source§

fn peek_finish(&self) -> (Self, Self::Slice)
where\n Self: Clone,

Advance to the end of the stream
","Stream","winnow::stream::Str"],["
source§

impl<'a> StreamIsPartial for &'a str

§

type PartialState = ()

Whether the stream is currently partial or complete
source§

fn complete(&mut self) -> Self::PartialState

Mark the stream is complete
source§

fn restore_partial(&mut self, _state: Self::PartialState)

Restore the stream back to its previous state
source§

fn is_partial_supported() -> bool

Report whether the Stream is can ever be incomplete
source§

fn is_partial(&self) -> bool

Report whether the Stream is currently incomplete
","StreamIsPartial","winnow::stream::Str"],["
1.72.0 · source§

impl<'a> TryFrom<&'a OsStr> for &'a str

source§

fn try_from(\n value: &'a OsStr\n) -> Result<&'a str, <&'a str as TryFrom<&'a OsStr>>::Error>

Tries to convert an &OsStr to a &str.

\n\n
use std::ffi::OsStr;\n\nlet os_str = OsStr::new(\"foo\");\nlet as_str = <&str>::try_from(os_str).unwrap();\nassert_eq!(as_str, \"foo\");
\n
§

type Error = Utf8Error

The type returned in the event of a conversion error.
","TryFrom<&'a OsStr>","winnow::stream::Str"],["
source§

impl<'a> UpdateSlice for &'a str

source§

fn update_slice(self, inner: Self::Slice) -> Self

Convert an Output type to be used as Stream
","UpdateSlice","winnow::stream::Str"]] +"winnow":[["
source§

impl<'a> AsBStr for &'a str

source§

fn as_bstr(&self) -> &[u8] ⓘ

Casts the input type to a byte slice
","AsBStr","winnow::stream::Str"],["
source§

impl<'a, 'b> Compare<&'b str> for &'a str

source§

fn compare(&self, t: &'b str) -> CompareResult

Compares self to another value for equality
","Compare<&'b str>","winnow::stream::Str"],["
source§

impl<'a, 'b> Compare<Caseless<&'b str>> for &'a str

source§

fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult

Compares self to another value for equality
","Compare>","winnow::stream::Str"],["
source§

impl<'a> Compare<Caseless<char>> for &'a str

source§

fn compare(&self, t: AsciiCaseless<char>) -> CompareResult

Compares self to another value for equality
","Compare>","winnow::stream::Str"],["
source§

impl<'a> Compare<char> for &'a str

source§

fn compare(&self, t: char) -> CompareResult

Compares self to another value for equality
","Compare","winnow::stream::Str"],["
1.0.0 · source§

impl Default for &str

source§

fn default() -> &str

Creates an empty str

\n
","Default","winnow::stream::Str"],["
1.0.0 · source§

impl !Error for &str

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Read more
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
","Error","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<&'s str> for &'i str

source§

fn find_slice(&self, substr: &'s str) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<&'s str>","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<(&'s str,)> for &'i str

source§

fn find_slice(&self, substr: (&'s str,)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(&'s str,)>","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i str

source§

fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(&'s str, &'s str)>","winnow::stream::Str"],["
source§

impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i str

source§

fn find_slice(\n &self,\n substr: (&'s str, &'s str, &'s str)\n) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(&'s str, &'s str, &'s str)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<(char,)> for &'i str

source§

fn find_slice(&self, substr: (char,)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(char,)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<(char, char)> for &'i str

source§

fn find_slice(&self, substr: (char, char)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(char, char)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<(char, char, char)> for &'i str

source§

fn find_slice(&self, substr: (char, char, char)) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice<(char, char, char)>","winnow::stream::Str"],["
source§

impl<'i> FindSlice<char> for &'i str

source§

fn find_slice(&self, substr: char) -> Option<Range<usize>>

Returns the offset of the slice if it is found
","FindSlice","winnow::stream::Str"],["
source§

impl<'a> Offset<<&'a str as Stream>::Checkpoint> for &'a str

source§

fn offset_from(&self, other: &<&'a str as Stream>::Checkpoint) -> usize

Offset between the first byte of start and the first byte of selfa Read more
","Offset<<&'a str as Stream>::Checkpoint>","winnow::stream::Str"],["
source§

impl<'a> Offset for &'a str

source§

fn offset_from(&self, start: &Self) -> usize

Offset between the first byte of start and the first byte of selfa Read more
","Offset","winnow::stream::Str"],["
source§

impl<'a, R: FromStr> ParseSlice<R> for &'a str

source§

fn parse_slice(&self) -> Option<R>

Succeeds if parse() succeeded Read more
","ParseSlice","winnow::stream::Str"],["
source§

impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s str
where\n I: Compare<&'s str> + StreamIsPartial + Stream,

This is a shortcut for literal.

\n

§Example

\n
\nfn parser<'s>(s: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {\n  alt((\"Hello\", take(5usize))).parse_next(s)\n}\n\nassert_eq!(parser.parse_peek(\"Hello, World!\"), Ok((\", World!\", \"Hello\")));\nassert_eq!(parser.parse_peek(\"Something\"), Ok((\"hing\", \"Somet\")));\nassert_eq!(parser.parse_peek(\"Some\"), Err(ErrMode::Backtrack(InputError::new(\"Some\", ErrorKind::Slice))));\nassert_eq!(parser.parse_peek(\"\"), Err(ErrMode::Backtrack(InputError::new(\"\", ErrorKind::Slice))));
\n
source§

fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

Take tokens from the Stream, turning it into the output Read more
source§

fn parse_peek(&mut self, input: I) -> IResult<I, O, E>

Take tokens from the Stream, turning it into the output Read more
source§

fn by_ref(&mut self) -> ByRef<'_, Self>
where\n Self: Sized,

Treat &mut Self as a parser Read more
source§

fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
where\n Self: Sized,\n O2: Clone,

Produce the provided value Read more
source§

fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
where\n Self: Sized,\n O2: Default,

Produce a type’s default value Read more
source§

fn void(self) -> Void<Self, I, O, E>
where\n Self: Sized,

Discards the output of the Parser Read more
source§

fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
where\n Self: Sized,\n O: Into<O2>,

Convert the parser’s output to another type using std::convert::From Read more
source§

fn recognize(self) -> Recognize<Self, I, O, E>
where\n Self: Sized,\n I: Stream,

Produce the consumed input as produced value. Read more
source§

fn with_recognized(self) -> WithRecognized<Self, I, O, E>
where\n Self: Sized,\n I: Stream,

Produce the consumed input with the output Read more
source§

fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
where\n G: FnMut(O) -> O2,\n Self: Sized,

Maps a function over the output of a parser Read more
source§

fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
where\n Self: Sized,\n G: FnMut(O) -> Result<O2, E2>,\n I: Stream,\n E: FromExternalError<I, E2>,

Applies a function returning a Result over the output of a parser. Read more
source§

fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
where\n Self: Sized,\n G: FnMut(O) -> Option<O2>,\n I: Stream,\n E: ParserError<I>,

Apply both Parser::verify and Parser::map. Read more
source§

fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
where\n Self: Sized,\n G: FnMut(O) -> H,\n H: Parser<I, O2, E>,

Creates a parser from the output of this one Read more
source§

fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
where\n Self: Sized,\n I: Stream,\n O: ParseSlice<O2>,\n E: ParserError<I>,

Apply std::str::FromStr to the output of the parser Read more
source§

fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
where\n Self: Sized,\n G: FnMut(&O2) -> bool,\n I: Stream,\n O: Borrow<O2>,\n O2: ?Sized,\n E: ParserError<I>,

Returns the output of the child parser if it satisfies a verification function. Read more
source§

fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
where\n Self: Sized,\n I: Stream,\n E: AddContext<I, C>,\n C: Clone + Debug,

If parsing fails, add context to the error Read more
source§

fn complete_err(self) -> CompleteErr<Self>
where\n Self: Sized,

Transforms Incomplete into Backtrack Read more
source§

fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
where\n Self: Sized,\n E: Into<E2>,

Convert the parser’s error to another type using std::convert::From
","Parser::Slice, E>","winnow::stream::Str"],["
source§

impl<'a> PartialEq<BStr> for &'a str

source§

fn eq(&self, other: &BStr) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
source§

impl<'a> PartialEq<Bytes> for &'a str

source§

fn eq(&self, other: &Bytes) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
1.0.0 · source§

impl<'a, 'b> PartialEq<Cow<'a, str>> for &'b str

source§

fn eq(&self, other: &Cow<'a, str>) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &Cow<'a, str>) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq>","winnow::stream::Str"],["
1.29.0 · source§

impl<'a> PartialEq<OsString> for &'a str

source§

fn eq(&self, other: &OsString) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
1.0.0 · source§

impl<'a, 'b> PartialEq<String> for &'a str

source§

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used\nby ==.
source§

fn ne(&self, other: &String) -> bool

This method tests for !=. The default implementation is almost always\nsufficient, and should not be overridden without very good reason.
","PartialEq","winnow::stream::Str"],["
source§

impl<'a> PartialOrd<BStr> for &'a str

source§

fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","winnow::stream::Str"],["
source§

impl<'a> PartialOrd<Bytes> for &'a str

source§

fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <=\noperator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >=\noperator. Read more
","PartialOrd","winnow::stream::Str"],["
source§

impl<'a, 'b> Pattern<'a> for &'b str

Non-allocating substring search.

\n

Will handle the pattern "" as returning empty matches at each character\nboundary.

\n

§Examples

\n
assert_eq!(\"Hello world\".find(\"world\"), Some(6));
\n
source§

fn is_prefix_of(self, haystack: &'a str) -> bool

🔬This is a nightly-only experimental API. (pattern)

Checks whether the pattern matches at the front of the haystack.

\n
source§

fn is_contained_in(self, haystack: &'a str) -> bool

🔬This is a nightly-only experimental API. (pattern)

Checks whether the pattern matches anywhere in the haystack

\n
source§

fn strip_prefix_of(self, haystack: &'a str) -> Option<&'a str>

🔬This is a nightly-only experimental API. (pattern)

Removes the pattern from the front of haystack, if it matches.

\n
source§

fn is_suffix_of(self, haystack: &'a str) -> bool

🔬This is a nightly-only experimental API. (pattern)

Checks whether the pattern matches at the back of the haystack.

\n
source§

fn strip_suffix_of(self, haystack: &'a str) -> Option<&'a str>

🔬This is a nightly-only experimental API. (pattern)

Removes the pattern from the back of haystack, if it matches.

\n
§

type Searcher = StrSearcher<'a, 'b>

🔬This is a nightly-only experimental API. (pattern)
Associated searcher for this pattern
source§

fn into_searcher(self, haystack: &'a str) -> StrSearcher<'a, 'b>

🔬This is a nightly-only experimental API. (pattern)
Constructs the associated searcher from\nself and the haystack to search in.
","Pattern<'a>","winnow::stream::Str"],["
source§

impl<'a> SliceLen for &'a str

source§

fn slice_len(&self) -> usize

Calculates the input length, as indicated by its name,\nand the name of the trait itself
","SliceLen","winnow::stream::Str"],["
source§

impl<'i> Stream for &'i str

§

type Token = char

The smallest unit being parsed Read more
§

type Slice = &'i str

Sequence of Tokens Read more
§

type IterOffsets = CharIndices<'i>

Iterate with the offset from the current location
§

type Checkpoint = Checkpoint<&'i str, &'i str>

A parse location within the stream
source§

fn iter_offsets(&self) -> Self::IterOffsets

Iterate with the offset from the current location
source§

fn eof_offset(&self) -> usize

Returns the offset to the end of the input
source§

fn next_token(&mut self) -> Option<Self::Token>

Split off the next token from the input
source§

fn offset_for<P>(&self, predicate: P) -> Option<usize>
where\n P: Fn(Self::Token) -> bool,

Finds the offset of the next matching token
source§

fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

Get the offset for the number of tokens into the stream Read more
source§

fn next_slice(&mut self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input Read more
source§

fn checkpoint(&self) -> Self::Checkpoint

Save the current parse location within the stream
source§

fn reset(&mut self, checkpoint: &Self::Checkpoint)

Revert the stream to a prior Self::Checkpoint Read more
source§

fn raw(&self) -> &dyn Debug

Return the inner-most stream
source§

fn peek_token(&self) -> Option<(Self, Self::Token)>
where\n Self: Clone,

Split off the next token from the input
source§

fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
where\n Self: Clone,

Split off a slice of tokens from the input
source§

fn finish(&mut self) -> Self::Slice

Advance to the end of the stream
source§

fn peek_finish(&self) -> (Self, Self::Slice)
where\n Self: Clone,

Advance to the end of the stream
","Stream","winnow::stream::Str"],["
source§

impl<'a> StreamIsPartial for &'a str

§

type PartialState = ()

Whether the stream is currently partial or complete
source§

fn complete(&mut self) -> Self::PartialState

Mark the stream is complete
source§

fn restore_partial(&mut self, _state: Self::PartialState)

Restore the stream back to its previous state
source§

fn is_partial_supported() -> bool

Report whether the Stream is can ever be incomplete
source§

fn is_partial(&self) -> bool

Report whether the Stream is currently incomplete
","StreamIsPartial","winnow::stream::Str"],["
1.72.0 · source§

impl<'a> TryFrom<&'a OsStr> for &'a str

source§

fn try_from(\n value: &'a OsStr\n) -> Result<&'a str, <&'a str as TryFrom<&'a OsStr>>::Error>

Tries to convert an &OsStr to a &str.

\n\n
use std::ffi::OsStr;\n\nlet os_str = OsStr::new(\"foo\");\nlet as_str = <&str>::try_from(os_str).unwrap();\nassert_eq!(as_str, \"foo\");
\n
§

type Error = Utf8Error

The type returned in the event of a conversion error.
","TryFrom<&'a OsStr>","winnow::stream::Str"],["
source§

impl<'a> UpdateSlice for &'a str

source§

fn update_slice(self, inner: Self::Slice) -> Self

Convert an Output type to be used as Stream
","UpdateSlice","winnow::stream::Str"]] };if (window.register_type_impls) {window.register_type_impls(type_impls);} else {window.pending_type_impls = type_impls;}})() \ No newline at end of file diff --git a/winnow/all.html b/winnow/all.html index dcd703f3d..47d49209d 100644 --- a/winnow/all.html +++ b/winnow/all.html @@ -1,2 +1,2 @@ -List of all items in this crate
+List of all items in this crate

List of all items

Structs

Enums

Traits

Macros

Functions

Type Aliases

\ No newline at end of file diff --git a/winnow/ascii/fn.alpha0.html b/winnow/ascii/fn.alpha0.html index dc16f3419..f9d372973 100644 --- a/winnow/ascii/fn.alpha0.html +++ b/winnow/ascii/fn.alpha0.html @@ -1,4 +1,4 @@ -alpha0 in winnow::ascii - Rust
+alpha0 in winnow::ascii - Rust

Function winnow::ascii::alpha0

source · 
pub fn alpha0<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.alpha1.html b/winnow/ascii/fn.alpha1.html
index 721f2e972..8be4443ae 100644
--- a/winnow/ascii/fn.alpha1.html
+++ b/winnow/ascii/fn.alpha1.html
@@ -1,4 +1,4 @@
-alpha1 in winnow::ascii - Rust

+alpha1 in winnow::ascii - Rust

     
Function winnow::ascii::alpha1
source · 
pub fn alpha1<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.alphanumeric0.html b/winnow/ascii/fn.alphanumeric0.html
index e33ffb6ba..4b2fd82da 100644
--- a/winnow/ascii/fn.alphanumeric0.html
+++ b/winnow/ascii/fn.alphanumeric0.html
@@ -1,4 +1,4 @@
-alphanumeric0 in winnow::ascii - Rust

+alphanumeric0 in winnow::ascii - Rust

     
Function winnow::ascii::alphanumeric0
source · 
pub fn alphanumeric0<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.alphanumeric1.html b/winnow/ascii/fn.alphanumeric1.html
index 8892a2b7c..00546c2c6 100644
--- a/winnow/ascii/fn.alphanumeric1.html
+++ b/winnow/ascii/fn.alphanumeric1.html
@@ -1,4 +1,4 @@
-alphanumeric1 in winnow::ascii - Rust

+alphanumeric1 in winnow::ascii - Rust

     
Function winnow::ascii::alphanumeric1
source · 
pub fn alphanumeric1<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.crlf.html b/winnow/ascii/fn.crlf.html
index e5b427bf3..8903c3c5c 100644
--- a/winnow/ascii/fn.crlf.html
+++ b/winnow/ascii/fn.crlf.html
@@ -1,4 +1,4 @@
-crlf in winnow::ascii - Rust

+crlf in winnow::ascii - Rust

     
Function winnow::ascii::crlf
source · 
pub fn crlf<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.dec_int.html b/winnow/ascii/fn.dec_int.html
index 3c60fd31d..8319e9214 100644
--- a/winnow/ascii/fn.dec_int.html
+++ b/winnow/ascii/fn.dec_int.html
@@ -1,4 +1,4 @@
-dec_int in winnow::ascii - Rust

+dec_int in winnow::ascii - Rust

     
Function winnow::ascii::dec_int
source · 
pub fn dec_int<Input, Output, Error>(
     input: &mut Input
 ) -> PResult<Output, Error>
where
diff --git a/winnow/ascii/fn.dec_uint.html b/winnow/ascii/fn.dec_uint.html
index 04babb7d3..d98054708 100644
--- a/winnow/ascii/fn.dec_uint.html
+++ b/winnow/ascii/fn.dec_uint.html
@@ -1,4 +1,4 @@
-dec_uint in winnow::ascii - Rust

+dec_uint in winnow::ascii - Rust

     
Function winnow::ascii::dec_uint
source · 
pub fn dec_uint<Input, Output, Error>(
     input: &mut Input
 ) -> PResult<Output, Error>
where
diff --git a/winnow/ascii/fn.digit0.html b/winnow/ascii/fn.digit0.html
index 508a40145..dcb4e06b4 100644
--- a/winnow/ascii/fn.digit0.html
+++ b/winnow/ascii/fn.digit0.html
@@ -1,4 +1,4 @@
-digit0 in winnow::ascii - Rust

+digit0 in winnow::ascii - Rust

     
Function winnow::ascii::digit0
source · 
pub fn digit0<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.digit1.html b/winnow/ascii/fn.digit1.html
index 22fdfb4f6..9f02145fb 100644
--- a/winnow/ascii/fn.digit1.html
+++ b/winnow/ascii/fn.digit1.html
@@ -1,4 +1,4 @@
-digit1 in winnow::ascii - Rust

+digit1 in winnow::ascii - Rust

     
Function winnow::ascii::digit1
source · 
pub fn digit1<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.escaped.html b/winnow/ascii/fn.escaped.html
index dd16e220f..657d397d3 100644
--- a/winnow/ascii/fn.escaped.html
+++ b/winnow/ascii/fn.escaped.html
@@ -1,4 +1,4 @@
-escaped in winnow::ascii - Rust

+escaped in winnow::ascii - Rust

     
Function winnow::ascii::escaped
source · 
pub fn escaped<'i, Input, Error, Normal, Escapable, NormalOutput, EscapableOutput>(
     normal: Normal,
     control_char: char,
diff --git a/winnow/ascii/fn.escaped_transform.html b/winnow/ascii/fn.escaped_transform.html
index 76195231a..d9748c8e5 100644
--- a/winnow/ascii/fn.escaped_transform.html
+++ b/winnow/ascii/fn.escaped_transform.html
@@ -1,5 +1,5 @@
-escaped_transform in winnow::ascii - Rust

-    
Function winnow::ascii::escaped_transform
source · 
pub fn escaped_transform<Input, Error, Normal, Escape, Output>(
+escaped_transform in winnow::ascii - Rust

+    
Function winnow::ascii::escaped_transform
source · 
pub fn escaped_transform<Input, Error, Normal, Escape, Output>(
     normal: Normal,
     control_char: char,
     escape: Escape
diff --git a/winnow/ascii/fn.float.html b/winnow/ascii/fn.float.html
index 273417f57..8a5de5460 100644
--- a/winnow/ascii/fn.float.html
+++ b/winnow/ascii/fn.float.html
@@ -1,4 +1,4 @@
-float in winnow::ascii - Rust

+float in winnow::ascii - Rust

     
Function winnow::ascii::float
source · 
pub fn float<Input, Output, Error>(input: &mut Input) -> PResult<Output, Error>
where
     Input: StreamIsPartial + Stream + Compare<Caseless<&'static str>> + Compare<char> + AsBStr,
     <Input as Stream>::Slice: ParseSlice<Output>,
diff --git a/winnow/ascii/fn.hex_digit0.html b/winnow/ascii/fn.hex_digit0.html
index 60d85770d..05c40c7d4 100644
--- a/winnow/ascii/fn.hex_digit0.html
+++ b/winnow/ascii/fn.hex_digit0.html
@@ -1,4 +1,4 @@
-hex_digit0 in winnow::ascii - Rust

+hex_digit0 in winnow::ascii - Rust

     
Function winnow::ascii::hex_digit0
source · 
pub fn hex_digit0<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.hex_digit1.html b/winnow/ascii/fn.hex_digit1.html
index 0d21e7e4e..aafdcd1be 100644
--- a/winnow/ascii/fn.hex_digit1.html
+++ b/winnow/ascii/fn.hex_digit1.html
@@ -1,4 +1,4 @@
-hex_digit1 in winnow::ascii - Rust

+hex_digit1 in winnow::ascii - Rust

     
Function winnow::ascii::hex_digit1
source · 
pub fn hex_digit1<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.hex_uint.html b/winnow/ascii/fn.hex_uint.html
index 8e939aff1..0b8df9e75 100644
--- a/winnow/ascii/fn.hex_uint.html
+++ b/winnow/ascii/fn.hex_uint.html
@@ -1,4 +1,4 @@
-hex_uint in winnow::ascii - Rust

+hex_uint in winnow::ascii - Rust

     
Function winnow::ascii::hex_uint
source · 
pub fn hex_uint<Input, Output, Error>(
     input: &mut Input
 ) -> PResult<Output, Error>
where
diff --git a/winnow/ascii/fn.line_ending.html b/winnow/ascii/fn.line_ending.html
index cbf1781ce..bc4ed5409 100644
--- a/winnow/ascii/fn.line_ending.html
+++ b/winnow/ascii/fn.line_ending.html
@@ -1,4 +1,4 @@
-line_ending in winnow::ascii - Rust

+line_ending in winnow::ascii - Rust

     
Function winnow::ascii::line_ending
source · 
pub fn line_ending<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.multispace0.html b/winnow/ascii/fn.multispace0.html
index 035ede48d..a6a4992dc 100644
--- a/winnow/ascii/fn.multispace0.html
+++ b/winnow/ascii/fn.multispace0.html
@@ -1,4 +1,4 @@
-multispace0 in winnow::ascii - Rust

+multispace0 in winnow::ascii - Rust

     
Function winnow::ascii::multispace0
source · 
pub fn multispace0<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.multispace1.html b/winnow/ascii/fn.multispace1.html
index d1558a22f..ea6038493 100644
--- a/winnow/ascii/fn.multispace1.html
+++ b/winnow/ascii/fn.multispace1.html
@@ -1,4 +1,4 @@
-multispace1 in winnow::ascii - Rust

+multispace1 in winnow::ascii - Rust

     
Function winnow::ascii::multispace1
source · 
pub fn multispace1<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.newline.html b/winnow/ascii/fn.newline.html
index c55d3e4fc..65b7f05d6 100644
--- a/winnow/ascii/fn.newline.html
+++ b/winnow/ascii/fn.newline.html
@@ -1,4 +1,4 @@
-newline in winnow::ascii - Rust

+newline in winnow::ascii - Rust

     
Function winnow::ascii::newline
source · 
pub fn newline<I, Error: ParserError<I>>(input: &mut I) -> PResult<char, Error>
where
     I: StreamIsPartial + Stream + Compare<char>,
Expand description
Matches a newline character '\n'.

 
Complete version: Will return an error if there’s not enough input data.

diff --git a/winnow/ascii/fn.oct_digit0.html b/winnow/ascii/fn.oct_digit0.html
index 94bec7d64..3714d9ce7 100644
--- a/winnow/ascii/fn.oct_digit0.html
+++ b/winnow/ascii/fn.oct_digit0.html
@@ -1,4 +1,4 @@
-oct_digit0 in winnow::ascii - Rust

+oct_digit0 in winnow::ascii - Rust

     
Function winnow::ascii::oct_digit0
source · 
pub fn oct_digit0<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.oct_digit1.html b/winnow/ascii/fn.oct_digit1.html
index 62365fbcb..288418b2b 100644
--- a/winnow/ascii/fn.oct_digit1.html
+++ b/winnow/ascii/fn.oct_digit1.html
@@ -1,4 +1,4 @@
-oct_digit1 in winnow::ascii - Rust

+oct_digit1 in winnow::ascii - Rust

     
Function winnow::ascii::oct_digit1
source · 
pub fn oct_digit1<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.space0.html b/winnow/ascii/fn.space0.html
index 06f279eee..19ef23c1f 100644
--- a/winnow/ascii/fn.space0.html
+++ b/winnow/ascii/fn.space0.html
@@ -1,4 +1,4 @@
-space0 in winnow::ascii - Rust

+space0 in winnow::ascii - Rust

     
Function winnow::ascii::space0
source · 
pub fn space0<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/fn.space1.html b/winnow/ascii/fn.space1.html
index 1c63d9459..c6609dfe2 100644
--- a/winnow/ascii/fn.space1.html
+++ b/winnow/ascii/fn.space1.html
@@ -1,10 +1,10 @@
-space1 in winnow::ascii - Rust

+space1 in winnow::ascii - Rust

     
Function winnow::ascii::space1
source · 
pub fn space1<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
     Input: StreamIsPartial + Stream,
     <Input as Stream>::Token: AsChar,
-    Error: ParserError<Input>,
Expand description
Recognizes zero or more spaces and tabs.

+    Error: ParserError<Input>,
Expand description
Recognizes one or more spaces and tabs.

 
Complete version: Will return the whole input if no terminating token is found (a non space
 character).

 
[Partial version][crate::_topic::partial]: Will return Err(winnow::error::ErrMode::Incomplete(_)) if there’s not enough input data,
diff --git a/winnow/ascii/fn.tab.html b/winnow/ascii/fn.tab.html
index e6c3d3a23..e5edb1e77 100644
--- a/winnow/ascii/fn.tab.html
+++ b/winnow/ascii/fn.tab.html
@@ -1,4 +1,4 @@
-tab in winnow::ascii - Rust

+tab in winnow::ascii - Rust

     
Function winnow::ascii::tab
source · 
pub fn tab<Input, Error>(input: &mut Input) -> PResult<char, Error>
where
     Input: StreamIsPartial + Stream + Compare<char>,
     Error: ParserError<Input>,
Expand description
Matches a tab character '\t'.

diff --git a/winnow/ascii/fn.take_escaped.html b/winnow/ascii/fn.take_escaped.html
index 6edaebc7e..d1f1e823c 100644
--- a/winnow/ascii/fn.take_escaped.html
+++ b/winnow/ascii/fn.take_escaped.html
@@ -1,4 +1,4 @@
-take_escaped in winnow::ascii - Rust

+take_escaped in winnow::ascii - Rust

     
Function winnow::ascii::take_escaped
source · 
pub fn take_escaped<'i, Input, Error, Normal, Escapable, NormalOutput, EscapableOutput>(
     normal: Normal,
     control_char: char,
diff --git a/winnow/ascii/fn.till_line_ending.html b/winnow/ascii/fn.till_line_ending.html
index 079fd8d42..20829fee3 100644
--- a/winnow/ascii/fn.till_line_ending.html
+++ b/winnow/ascii/fn.till_line_ending.html
@@ -1,4 +1,4 @@
-till_line_ending in winnow::ascii - Rust

+till_line_ending in winnow::ascii - Rust

     
Function winnow::ascii::till_line_ending
source · 
pub fn till_line_ending<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
where
diff --git a/winnow/ascii/index.html b/winnow/ascii/index.html
index 06dcaa71a..d497a51c4 100644
--- a/winnow/ascii/index.html
+++ b/winnow/ascii/index.html
@@ -1,6 +1,6 @@
-winnow::ascii - Rust

-    
Module winnow::ascii
source · 
Expand description
Character specific parsers and combinators

+winnow::ascii - Rust

+    
Module winnow::ascii
source · 
Expand description
Character specific parsers and combinators

 
Functions recognizing specific characters

 
Structs§
  • Caseless
    Mark a value as case-insensitive for ASCII characters
Traits§
Functions§
  • alpha0
    Recognizes zero or more lowercase and uppercase ASCII alphabetic characters: 'a'..='z', 'A'..='Z'
  • alpha1
    Recognizes one or more lowercase and uppercase ASCII alphabetic characters: 'a'..='z', 'A'..='Z'
  • alphanumeric0
    Recognizes zero or more ASCII numerical and alphabetic characters: 'a'..='z', 'A'..='Z', '0'..='9'
  • alphanumeric1
    Recognizes one or more ASCII numerical and alphabetic characters: 'a'..='z', 'A'..='Z', '0'..='9'
  • crlf
    Recognizes the string "\r\n".
  • dec_int
    Decode a decimal signed integer (e.g. i32)
  • dec_uint
    Decode a decimal unsigned integer (e.g. u32)
  • digit0
    Recognizes zero or more ASCII numerical characters: '0'..='9'
  • digit1
    Recognizes one or more ASCII numerical characters: '0'..='9'
  • escapedDeprecated
    Deprecated, replaced with take_escaped
  • escaped_transform
    Parse escaped characters, unescaping them
  • float
    Recognizes floating point number in text format and returns a f32 or f64.
  • hex_digit0
    Recognizes zero or more ASCII hexadecimal numerical characters: '0'..='9', 'A'..='F',
 'a'..='f'
  • hex_digit1
    Recognizes one or more ASCII hexadecimal numerical characters: '0'..='9', 'A'..='F',
-'a'..='f'
  • hex_uint
    Decode a variable-width hexadecimal integer (e.g. u32)
  • line_ending
    Recognizes an end of line (both "\n" and "\r\n").
  • multispace0
    Recognizes zero or more spaces, tabs, carriage returns and line feeds.
  • multispace1
    Recognizes one or more spaces, tabs, carriage returns and line feeds.
  • newline
    Matches a newline character '\n'.
  • oct_digit0
    Recognizes zero or more octal characters: '0'..='7'
  • oct_digit1
    Recognizes one or more octal characters: '0'..='7'
  • space0
    Recognizes zero or more spaces and tabs.
  • space1
    Recognizes zero or more spaces and tabs.
  • tab
    Matches a tab character '\t'.
  • take_escaped
    Recognize the input slice with escaped characters.
  • till_line_ending
    Recognizes a string of any char except "\r\n" or "\n".

\ No newline at end of file
+'a'..='f'
  • hex_uint
    Decode a variable-width hexadecimal integer (e.g. u32)
  • line_ending
    Recognizes an end of line (both "\n" and "\r\n").
  • multispace0
    Recognizes zero or more spaces, tabs, carriage returns and line feeds.
  • multispace1
    Recognizes one or more spaces, tabs, carriage returns and line feeds.
  • newline
    Matches a newline character '\n'.
  • oct_digit0
    Recognizes zero or more octal characters: '0'..='7'
  • oct_digit1
    Recognizes one or more octal characters: '0'..='7'
  • space0
    Recognizes zero or more spaces and tabs.
  • space1
    Recognizes one or more spaces and tabs.
  • tab
    Matches a tab character '\t'.
  • take_escaped
    Recognize the input slice with escaped characters.
  • till_line_ending
    Recognizes a string of any char except "\r\n" or "\n".
    • 
\ No newline at end of file
diff --git a/winnow/ascii/struct.Caseless.html b/winnow/ascii/struct.Caseless.html
index 3e9bdd545..9a1b52fb2 100644
--- a/winnow/ascii/struct.Caseless.html
+++ b/winnow/ascii/struct.Caseless.html
@@ -1,4 +1,4 @@
-Caseless in winnow::ascii - Rust
    
+Caseless in winnow::ascii - Rust
    
     
    Struct winnow::ascii::Caseless
    source · 
    pub struct Caseless<T>(pub T);
    Expand description
    Mark a value as case-insensitive for ASCII characters
    
 
    §Example
    
 
    
@@ -12,9 +12,9 @@
 assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Tag))));
 assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
    
 
    Tuple Fields§
    §0: T
    Implementations§
    source§
    impl Caseless<&str>
    source
    pub fn as_bytes(&self) -> Caseless<&[u8]>
    Get the byte-representation of this case-insensitive value
    
-
    Trait Implementations§
    source§
    impl<T: Clone> Clone for Caseless<T>
    source§
    fn clone(&self) -> Caseless<T>
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl<'a, 'b> Compare<Caseless<&'b [u8]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, 'b, const LEN: usize> Compare<Caseless<&'b [u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8; LEN]>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, const LEN: usize> Compare<Caseless<[u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<[u8; LEN]>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a> Compare<Caseless<char>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a> Compare<Caseless<char>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a> Compare<Caseless<u8>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<u8>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<T: Debug> Debug for Caseless<T>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8]>
    where
+
    Trait Implementations§
    source§
    impl<T: Clone> Clone for Caseless<T>
    source§
    fn clone(&self) -> Caseless<T>
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl<'a, 'b> Compare<Caseless<&'b [u8]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, 'b, const LEN: usize> Compare<Caseless<&'b [u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8; LEN]>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a, const LEN: usize> Compare<Caseless<[u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<[u8; LEN]>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a> Compare<Caseless<char>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a> Compare<Caseless<char>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<'a> Compare<Caseless<u8>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<u8>) -> CompareResult
    Compares self to another value for equality
    source§
    impl<T: Debug> Debug for Caseless<T>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8]>
    where
     I: Compare<Caseless<&'s [u8]>> + StreamIsPartial + Stream,
    This is a shortcut for literal.
    
-
    §Example
    
+
    §Example
    
 
    use winnow::ascii::Caseless;
 
 fn parser<'s>(s: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
@@ -27,49 +27,49 @@
 assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
 assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
    
-
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
-    E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    source§
    impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8; N]>
    where
+    E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    source§
    impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8; N]>
    where
     I: Compare<Caseless<&'s [u8; N]>> + StreamIsPartial + Stream,
    This is a shortcut for literal.
    
 
    §Example
    
 
    use winnow::ascii::Caseless;
@@ -84,51 +84,51 @@
 assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
 assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
    
-
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
-    E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    source§
    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s str>
    where
+    E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    source§
    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s str>
    where
     I: Compare<Caseless<&'s str>> + StreamIsPartial + Stream,
    This is a shortcut for literal.
    
-
    §Example
    
+
    §Example
    
 
    
 fn parser<'s>(s: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
   alt((Caseless("hello"), take(5usize))).parse_next(s)
@@ -140,49 +140,49 @@
 assert_eq!(parser.parse_peek("Something"), Ok(("hing", "Somet")));
 assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
    
-
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
-    E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    source§
    impl<S: SliceLen> SliceLen for Caseless<S>
    source§
    fn slice_len(&self) -> usize
    Calculates the input length, as indicated by its name,
+    E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    source§

    impl<S: SliceLen> SliceLen for Caseless<S>

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, and the name of the trait itself
    source§

    impl<T: Copy> Copy for Caseless<T>

    Auto Trait Implementations§

    §

    impl<T> Freeze for Caseless<T>
    where T: Freeze,

    §

    impl<T> RefUnwindSafe for Caseless<T>
    where T: RefUnwindSafe,

    §

    impl<T> Send for Caseless<T>
    where diff --git a/winnow/ascii/trait.HexUint.html b/winnow/ascii/trait.HexUint.html index e2adf97d0..eaadb0d5c 100644 --- a/winnow/ascii/trait.HexUint.html +++ b/winnow/ascii/trait.HexUint.html @@ -1,3 +1,3 @@ -HexUint in winnow::ascii - Rust
    +HexUint in winnow::ascii - Rust

    Trait winnow::ascii::HexUint

    source · 
    pub trait HexUint: Default + Shl<Self, Output = Self> + Add<Self, Output = Self> + From<u8> { }
    Expand description

    Metadata for parsing hex numbers, see hex_uint

    Object Safety§

    This trait is not object safe.

    Implementations on Foreign Types§

    source§

    impl HexUint for u8

    source§

    impl HexUint for u16

    source§

    impl HexUint for u32

    source§

    impl HexUint for u64

    source§

    impl HexUint for u128

    Implementors§

    \ No newline at end of file diff --git a/winnow/ascii/trait.Int.html b/winnow/ascii/trait.Int.html index 3e3746b58..b6fb19e99 100644 --- a/winnow/ascii/trait.Int.html +++ b/winnow/ascii/trait.Int.html @@ -1,3 +1,3 @@ -Int in winnow::ascii - Rust
    +Int in winnow::ascii - Rust

    Trait winnow::ascii::Int

    source · 
    pub trait Int: Sized { }
    Expand description

    Metadata for parsing signed integers, see dec_int

    Object Safety§

    This trait is not object safe.

    Implementations on Foreign Types§

    source§

    impl Int for i8

    source§

    impl Int for i16

    source§

    impl Int for i32

    source§

    impl Int for i64

    source§

    impl Int for i128

    source§

    impl Int for isize

    Implementors§

    \ No newline at end of file diff --git a/winnow/ascii/trait.Uint.html b/winnow/ascii/trait.Uint.html index 0f9cadc88..4eb0d7b3a 100644 --- a/winnow/ascii/trait.Uint.html +++ b/winnow/ascii/trait.Uint.html @@ -1,3 +1,3 @@ -Uint in winnow::ascii - Rust
    +Uint in winnow::ascii - Rust

    Trait winnow::ascii::Uint

    source · 
    pub trait Uint: Sized { }
    Expand description

    Metadata for parsing unsigned integers, see dec_uint

    Object Safety§

    This trait is not object safe.

    Implementations on Foreign Types§

    source§

    impl Uint for u8

    source§

    impl Uint for u16

    source§

    impl Uint for u32

    source§

    impl Uint for u64

    source§

    impl Uint for u128

    source§

    impl Uint for usize

    Implementors§

    \ No newline at end of file diff --git a/winnow/binary/bits/fn.bits.html b/winnow/binary/bits/fn.bits.html index e7fa68955..17a46dccb 100644 --- a/winnow/binary/bits/fn.bits.html +++ b/winnow/binary/bits/fn.bits.html @@ -1,4 +1,4 @@ -bits in winnow::binary::bits - Rust
    +bits in winnow::binary::bits - Rust

    Function winnow::binary::bits::bits

    source · 
    pub fn bits<Input, Output, BitError, ByteError, ParseNext>(
     parser: ParseNext
 ) -> impl Parser<Input, Output, ByteError>
    where
diff --git a/winnow/binary/bits/fn.bool.html b/winnow/binary/bits/fn.bool.html
index 3824f2dca..6b02c13af 100644
--- a/winnow/binary/bits/fn.bool.html
+++ b/winnow/binary/bits/fn.bool.html
@@ -1,4 +1,4 @@
-bool in winnow::binary::bits - Rust
    
+bool in winnow::binary::bits - Rust
    
     
    Function winnow::binary::bits::bool
    source · 
    pub fn bool<Input, Error: ParserError<(Input, usize)>>(
     input: &mut (Input, usize)
 ) -> PResult<bool, Error>
    where
diff --git a/winnow/binary/bits/fn.bytes.html b/winnow/binary/bits/fn.bytes.html
index 304feebd8..63053dbee 100644
--- a/winnow/binary/bits/fn.bytes.html
+++ b/winnow/binary/bits/fn.bytes.html
@@ -1,4 +1,4 @@
-bytes in winnow::binary::bits - Rust
    
+bytes in winnow::binary::bits - Rust
    
     
    Function winnow::binary::bits::bytes
    source · 
    pub fn bytes<Input, Output, ByteError, BitError, ParseNext>(
     parser: ParseNext
 ) -> impl Parser<(Input, usize), Output, BitError>
    where
diff --git a/winnow/binary/bits/fn.pattern.html b/winnow/binary/bits/fn.pattern.html
index 23a8c9cc4..399947469 100644
--- a/winnow/binary/bits/fn.pattern.html
+++ b/winnow/binary/bits/fn.pattern.html
@@ -1,4 +1,4 @@
-pattern in winnow::binary::bits - Rust
    
+pattern in winnow::binary::bits - Rust
    
     
    Function winnow::binary::bits::pattern
    source · 
    pub fn pattern<Input, Output, Count, Error: ParserError<(Input, usize)>>(
     pattern: Output,
     count: Count
diff --git a/winnow/binary/bits/fn.take.html b/winnow/binary/bits/fn.take.html
index 4ce28978d..9eb42cbfe 100644
--- a/winnow/binary/bits/fn.take.html
+++ b/winnow/binary/bits/fn.take.html
@@ -1,4 +1,4 @@
-take in winnow::binary::bits - Rust
    
+take in winnow::binary::bits - Rust
    
     
    Function winnow::binary::bits::take
    source · 
    pub fn take<Input, Output, Count, Error>(
     count: Count
 ) -> impl Parser<(Input, usize), Output, Error>
    where
diff --git a/winnow/binary/bits/index.html b/winnow/binary/bits/index.html
index 4918c674f..92ee86af1 100644
--- a/winnow/binary/bits/index.html
+++ b/winnow/binary/bits/index.html
@@ -1,3 +1,3 @@
-winnow::binary::bits - Rust
    
+winnow::binary::bits - Rust
    
     
    Module winnow::binary::bits
    source · 
    Expand description
    Bit level parsers
    
 
    Functions§
    • bits
      Converts a byte-level input to a bit-level input
    • bool
      Parses one specific bit as a bool.
    • bytes
      Convert a bits stream back into a byte stream
    • pattern
      Parse taking count bits and comparing them to pattern
    • take
      Parse taking count bits
    
\ No newline at end of file
diff --git a/winnow/binary/enum.Endianness.html b/winnow/binary/enum.Endianness.html
index d55554c35..dfa13b7a7 100644
--- a/winnow/binary/enum.Endianness.html
+++ b/winnow/binary/enum.Endianness.html
@@ -1,4 +1,4 @@
-Endianness in winnow::binary - Rust
    
+Endianness in winnow::binary - Rust
    
     
    Enum winnow::binary::Endianness
    source · 
    pub enum Endianness {
     Big,
     Little,
diff --git a/winnow/binary/fn.be_f32.html b/winnow/binary/fn.be_f32.html
index 453a78d63..4a9e8f089 100644
--- a/winnow/binary/fn.be_f32.html
+++ b/winnow/binary/fn.be_f32.html
@@ -1,4 +1,4 @@
-be_f32 in winnow::binary - Rust
    
+be_f32 in winnow::binary - Rust
    
     
    Function winnow::binary::be_f32
    source · 
    pub fn be_f32<Input, Error>(input: &mut Input) -> PResult<f32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_f64.html b/winnow/binary/fn.be_f64.html
index 0cd647329..18dc2044a 100644
--- a/winnow/binary/fn.be_f64.html
+++ b/winnow/binary/fn.be_f64.html
@@ -1,4 +1,4 @@
-be_f64 in winnow::binary - Rust
    
+be_f64 in winnow::binary - Rust
    
     
    Function winnow::binary::be_f64
    source · 
    pub fn be_f64<Input, Error>(input: &mut Input) -> PResult<f64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_i128.html b/winnow/binary/fn.be_i128.html
index 8686583c2..4ccb45077 100644
--- a/winnow/binary/fn.be_i128.html
+++ b/winnow/binary/fn.be_i128.html
@@ -1,4 +1,4 @@
-be_i128 in winnow::binary - Rust
    
+be_i128 in winnow::binary - Rust
    
     
    Function winnow::binary::be_i128
    source · 
    pub fn be_i128<Input, Error>(input: &mut Input) -> PResult<i128, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_i16.html b/winnow/binary/fn.be_i16.html
index 6512460f5..3c7173b43 100644
--- a/winnow/binary/fn.be_i16.html
+++ b/winnow/binary/fn.be_i16.html
@@ -1,4 +1,4 @@
-be_i16 in winnow::binary - Rust
    
+be_i16 in winnow::binary - Rust
    
     
    Function winnow::binary::be_i16
    source · 
    pub fn be_i16<Input, Error>(input: &mut Input) -> PResult<i16, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_i24.html b/winnow/binary/fn.be_i24.html
index 9e33a55a5..394eb0a54 100644
--- a/winnow/binary/fn.be_i24.html
+++ b/winnow/binary/fn.be_i24.html
@@ -1,4 +1,4 @@
-be_i24 in winnow::binary - Rust
    
+be_i24 in winnow::binary - Rust
    
     
    Function winnow::binary::be_i24
    source · 
    pub fn be_i24<Input, Error>(input: &mut Input) -> PResult<i32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_i32.html b/winnow/binary/fn.be_i32.html
index 6884025ce..9ae86a1e0 100644
--- a/winnow/binary/fn.be_i32.html
+++ b/winnow/binary/fn.be_i32.html
@@ -1,4 +1,4 @@
-be_i32 in winnow::binary - Rust
    
+be_i32 in winnow::binary - Rust
    
     
    Function winnow::binary::be_i32
    source · 
    pub fn be_i32<Input, Error>(input: &mut Input) -> PResult<i32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_i64.html b/winnow/binary/fn.be_i64.html
index a6f74d026..4759e8b16 100644
--- a/winnow/binary/fn.be_i64.html
+++ b/winnow/binary/fn.be_i64.html
@@ -1,4 +1,4 @@
-be_i64 in winnow::binary - Rust
    
+be_i64 in winnow::binary - Rust
    
     
    Function winnow::binary::be_i64
    source · 
    pub fn be_i64<Input, Error>(input: &mut Input) -> PResult<i64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_i8.html b/winnow/binary/fn.be_i8.html
index f041a9f45..e40079839 100644
--- a/winnow/binary/fn.be_i8.html
+++ b/winnow/binary/fn.be_i8.html
@@ -1,4 +1,4 @@
-be_i8 in winnow::binary - Rust
    
+be_i8 in winnow::binary - Rust
    
     
    Function winnow::binary::be_i8
    source · 
    pub fn be_i8<Input, Error>(input: &mut Input) -> PResult<i8, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     Error: ParserError<Input>,
    Expand description
    Recognizes a signed 1 byte integer.
    
diff --git a/winnow/binary/fn.be_u128.html b/winnow/binary/fn.be_u128.html
index 884602f4e..d4f5aadd2 100644
--- a/winnow/binary/fn.be_u128.html
+++ b/winnow/binary/fn.be_u128.html
@@ -1,4 +1,4 @@
-be_u128 in winnow::binary - Rust
    
+be_u128 in winnow::binary - Rust
    
     
    Function winnow::binary::be_u128
    source · 
    pub fn be_u128<Input, Error>(input: &mut Input) -> PResult<u128, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_u16.html b/winnow/binary/fn.be_u16.html
index 889977bcf..aeaa8b6ce 100644
--- a/winnow/binary/fn.be_u16.html
+++ b/winnow/binary/fn.be_u16.html
@@ -1,4 +1,4 @@
-be_u16 in winnow::binary - Rust
    
+be_u16 in winnow::binary - Rust
    
     
    Function winnow::binary::be_u16
    source · 
    pub fn be_u16<Input, Error>(input: &mut Input) -> PResult<u16, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_u24.html b/winnow/binary/fn.be_u24.html
index e20a00963..229afebf8 100644
--- a/winnow/binary/fn.be_u24.html
+++ b/winnow/binary/fn.be_u24.html
@@ -1,4 +1,4 @@
-be_u24 in winnow::binary - Rust
    
+be_u24 in winnow::binary - Rust
    
     
    Function winnow::binary::be_u24
    source · 
    pub fn be_u24<Input, Error>(input: &mut Input) -> PResult<u32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_u32.html b/winnow/binary/fn.be_u32.html
index 22970e135..8ab2320ff 100644
--- a/winnow/binary/fn.be_u32.html
+++ b/winnow/binary/fn.be_u32.html
@@ -1,4 +1,4 @@
-be_u32 in winnow::binary - Rust
    
+be_u32 in winnow::binary - Rust
    
     
    Function winnow::binary::be_u32
    source · 
    pub fn be_u32<Input, Error>(input: &mut Input) -> PResult<u32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_u64.html b/winnow/binary/fn.be_u64.html
index 8bb528abd..ee5b3b1dd 100644
--- a/winnow/binary/fn.be_u64.html
+++ b/winnow/binary/fn.be_u64.html
@@ -1,4 +1,4 @@
-be_u64 in winnow::binary - Rust
    
+be_u64 in winnow::binary - Rust
    
     
    Function winnow::binary::be_u64
    source · 
    pub fn be_u64<Input, Error>(input: &mut Input) -> PResult<u64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.be_u8.html b/winnow/binary/fn.be_u8.html
index 59ab32000..746b27d04 100644
--- a/winnow/binary/fn.be_u8.html
+++ b/winnow/binary/fn.be_u8.html
@@ -1,4 +1,4 @@
-be_u8 in winnow::binary - Rust
    
+be_u8 in winnow::binary - Rust
    
     
    Function winnow::binary::be_u8
    source · 
    pub fn be_u8<Input, Error>(input: &mut Input) -> PResult<u8, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     Error: ParserError<Input>,
    Expand description
    Recognizes an unsigned 1 byte integer.
    
diff --git a/winnow/binary/fn.f32.html b/winnow/binary/fn.f32.html
index eb386d21a..730c5c65a 100644
--- a/winnow/binary/fn.f32.html
+++ b/winnow/binary/fn.f32.html
@@ -1,4 +1,4 @@
-f32 in winnow::binary - Rust
    
+f32 in winnow::binary - Rust
    
     
    Function winnow::binary::f32
    source · 
    pub fn f32<Input, Error>(endian: Endianness) -> impl Parser<Input, f32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.f64.html b/winnow/binary/fn.f64.html
index 9644fb0e4..085282bf6 100644
--- a/winnow/binary/fn.f64.html
+++ b/winnow/binary/fn.f64.html
@@ -1,4 +1,4 @@
-f64 in winnow::binary - Rust
    
+f64 in winnow::binary - Rust
    
     
    Function winnow::binary::f64
    source · 
    pub fn f64<Input, Error>(endian: Endianness) -> impl Parser<Input, f64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.i128.html b/winnow/binary/fn.i128.html
index 76e40bc21..6cc042a2f 100644
--- a/winnow/binary/fn.i128.html
+++ b/winnow/binary/fn.i128.html
@@ -1,4 +1,4 @@
-i128 in winnow::binary - Rust
    
+i128 in winnow::binary - Rust
    
     
    Function winnow::binary::i128
    source · 
    pub fn i128<Input, Error>(endian: Endianness) -> impl Parser<Input, i128, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.i16.html b/winnow/binary/fn.i16.html
index 25165fc22..31d9fa52d 100644
--- a/winnow/binary/fn.i16.html
+++ b/winnow/binary/fn.i16.html
@@ -1,4 +1,4 @@
-i16 in winnow::binary - Rust
    
+i16 in winnow::binary - Rust
    
     
    Function winnow::binary::i16
    source · 
    pub fn i16<Input, Error>(endian: Endianness) -> impl Parser<Input, i16, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.i24.html b/winnow/binary/fn.i24.html
index 410408007..a7163cdaa 100644
--- a/winnow/binary/fn.i24.html
+++ b/winnow/binary/fn.i24.html
@@ -1,4 +1,4 @@
-i24 in winnow::binary - Rust
    
+i24 in winnow::binary - Rust
    
     
    Function winnow::binary::i24
    source · 
    pub fn i24<Input, Error>(endian: Endianness) -> impl Parser<Input, i32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.i32.html b/winnow/binary/fn.i32.html
index 9f6f2a6d7..f1422239c 100644
--- a/winnow/binary/fn.i32.html
+++ b/winnow/binary/fn.i32.html
@@ -1,4 +1,4 @@
-i32 in winnow::binary - Rust
    
+i32 in winnow::binary - Rust
    
     
    Function winnow::binary::i32
    source · 
    pub fn i32<Input, Error>(endian: Endianness) -> impl Parser<Input, i32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.i64.html b/winnow/binary/fn.i64.html
index 7f119af6a..1baf9685f 100644
--- a/winnow/binary/fn.i64.html
+++ b/winnow/binary/fn.i64.html
@@ -1,4 +1,4 @@
-i64 in winnow::binary - Rust
    
+i64 in winnow::binary - Rust
    
     
    Function winnow::binary::i64
    source · 
    pub fn i64<Input, Error>(endian: Endianness) -> impl Parser<Input, i64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.i8.html b/winnow/binary/fn.i8.html
index c52f0c464..cf64db1a0 100644
--- a/winnow/binary/fn.i8.html
+++ b/winnow/binary/fn.i8.html
@@ -1,4 +1,4 @@
-i8 in winnow::binary - Rust
    
+i8 in winnow::binary - Rust
    
     
    Function winnow::binary::i8
    source · 
    pub fn i8<Input, Error>(input: &mut Input) -> PResult<i8, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     Error: ParserError<Input>,
    Expand description
    Recognizes a signed 1 byte integer
    
diff --git a/winnow/binary/fn.le_f32.html b/winnow/binary/fn.le_f32.html
index b228c9131..ad39b6e80 100644
--- a/winnow/binary/fn.le_f32.html
+++ b/winnow/binary/fn.le_f32.html
@@ -1,4 +1,4 @@
-le_f32 in winnow::binary - Rust
    
+le_f32 in winnow::binary - Rust
    
     
    Function winnow::binary::le_f32
    source · 
    pub fn le_f32<Input, Error>(input: &mut Input) -> PResult<f32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_f64.html b/winnow/binary/fn.le_f64.html
index 9031eb840..335cdbbe9 100644
--- a/winnow/binary/fn.le_f64.html
+++ b/winnow/binary/fn.le_f64.html
@@ -1,4 +1,4 @@
-le_f64 in winnow::binary - Rust
    
+le_f64 in winnow::binary - Rust
    
     
    Function winnow::binary::le_f64
    source · 
    pub fn le_f64<Input, Error>(input: &mut Input) -> PResult<f64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_i128.html b/winnow/binary/fn.le_i128.html
index 293eebf9a..ddc12e589 100644
--- a/winnow/binary/fn.le_i128.html
+++ b/winnow/binary/fn.le_i128.html
@@ -1,4 +1,4 @@
-le_i128 in winnow::binary - Rust
    
+le_i128 in winnow::binary - Rust
    
     
    Function winnow::binary::le_i128
    source · 
    pub fn le_i128<Input, Error>(input: &mut Input) -> PResult<i128, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_i16.html b/winnow/binary/fn.le_i16.html
index 9e6df137b..8ba44c230 100644
--- a/winnow/binary/fn.le_i16.html
+++ b/winnow/binary/fn.le_i16.html
@@ -1,4 +1,4 @@
-le_i16 in winnow::binary - Rust
    
+le_i16 in winnow::binary - Rust
    
     
    Function winnow::binary::le_i16
    source · 
    pub fn le_i16<Input, Error>(input: &mut Input) -> PResult<i16, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_i24.html b/winnow/binary/fn.le_i24.html
index 962430ddd..9fe78691c 100644
--- a/winnow/binary/fn.le_i24.html
+++ b/winnow/binary/fn.le_i24.html
@@ -1,4 +1,4 @@
-le_i24 in winnow::binary - Rust
    
+le_i24 in winnow::binary - Rust
    
     
    Function winnow::binary::le_i24
    source · 
    pub fn le_i24<Input, Error>(input: &mut Input) -> PResult<i32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_i32.html b/winnow/binary/fn.le_i32.html
index bf27f9906..720e6e5ba 100644
--- a/winnow/binary/fn.le_i32.html
+++ b/winnow/binary/fn.le_i32.html
@@ -1,4 +1,4 @@
-le_i32 in winnow::binary - Rust
    
+le_i32 in winnow::binary - Rust
    
     
    Function winnow::binary::le_i32
    source · 
    pub fn le_i32<Input, Error>(input: &mut Input) -> PResult<i32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_i64.html b/winnow/binary/fn.le_i64.html
index ffe8c207a..8432a0852 100644
--- a/winnow/binary/fn.le_i64.html
+++ b/winnow/binary/fn.le_i64.html
@@ -1,4 +1,4 @@
-le_i64 in winnow::binary - Rust
    
+le_i64 in winnow::binary - Rust
    
     
    Function winnow::binary::le_i64
    source · 
    pub fn le_i64<Input, Error>(input: &mut Input) -> PResult<i64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_i8.html b/winnow/binary/fn.le_i8.html
index 0c915252d..588b508a7 100644
--- a/winnow/binary/fn.le_i8.html
+++ b/winnow/binary/fn.le_i8.html
@@ -1,4 +1,4 @@
-le_i8 in winnow::binary - Rust
    
+le_i8 in winnow::binary - Rust
    
     
    Function winnow::binary::le_i8
    source · 
    pub fn le_i8<Input, Error>(input: &mut Input) -> PResult<i8, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     Error: ParserError<Input>,
    Expand description
    Recognizes a signed 1 byte integer.
    
diff --git a/winnow/binary/fn.le_u128.html b/winnow/binary/fn.le_u128.html
index 3890c2ab7..1fbe6e1aa 100644
--- a/winnow/binary/fn.le_u128.html
+++ b/winnow/binary/fn.le_u128.html
@@ -1,4 +1,4 @@
-le_u128 in winnow::binary - Rust
    
+le_u128 in winnow::binary - Rust
    
     
    Function winnow::binary::le_u128
    source · 
    pub fn le_u128<Input, Error>(input: &mut Input) -> PResult<u128, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_u16.html b/winnow/binary/fn.le_u16.html
index bcc684fa9..67043affb 100644
--- a/winnow/binary/fn.le_u16.html
+++ b/winnow/binary/fn.le_u16.html
@@ -1,4 +1,4 @@
-le_u16 in winnow::binary - Rust
    
+le_u16 in winnow::binary - Rust
    
     
    Function winnow::binary::le_u16
    source · 
    pub fn le_u16<Input, Error>(input: &mut Input) -> PResult<u16, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_u24.html b/winnow/binary/fn.le_u24.html
index bb3f8f378..07b21be6a 100644
--- a/winnow/binary/fn.le_u24.html
+++ b/winnow/binary/fn.le_u24.html
@@ -1,4 +1,4 @@
-le_u24 in winnow::binary - Rust
    
+le_u24 in winnow::binary - Rust
    
     
    Function winnow::binary::le_u24
    source · 
    pub fn le_u24<Input, Error>(input: &mut Input) -> PResult<u32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_u32.html b/winnow/binary/fn.le_u32.html
index 1539d1849..c9678ee73 100644
--- a/winnow/binary/fn.le_u32.html
+++ b/winnow/binary/fn.le_u32.html
@@ -1,4 +1,4 @@
-le_u32 in winnow::binary - Rust
    
+le_u32 in winnow::binary - Rust
    
     
    Function winnow::binary::le_u32
    source · 
    pub fn le_u32<Input, Error>(input: &mut Input) -> PResult<u32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_u64.html b/winnow/binary/fn.le_u64.html
index 3962d2a2f..95434ff46 100644
--- a/winnow/binary/fn.le_u64.html
+++ b/winnow/binary/fn.le_u64.html
@@ -1,4 +1,4 @@
-le_u64 in winnow::binary - Rust
    
+le_u64 in winnow::binary - Rust
    
     
    Function winnow::binary::le_u64
    source · 
    pub fn le_u64<Input, Error>(input: &mut Input) -> PResult<u64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.le_u8.html b/winnow/binary/fn.le_u8.html
index 4dd2b9835..b630dd7d2 100644
--- a/winnow/binary/fn.le_u8.html
+++ b/winnow/binary/fn.le_u8.html
@@ -1,4 +1,4 @@
-le_u8 in winnow::binary - Rust
    
+le_u8 in winnow::binary - Rust
    
     
    Function winnow::binary::le_u8
    source · 
    pub fn le_u8<Input, Error>(input: &mut Input) -> PResult<u8, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     Error: ParserError<Input>,
    Expand description
    Recognizes an unsigned 1 byte integer.
    
diff --git a/winnow/binary/fn.length_and_then.html b/winnow/binary/fn.length_and_then.html
index a1c644d59..40d568abb 100644
--- a/winnow/binary/fn.length_and_then.html
+++ b/winnow/binary/fn.length_and_then.html
@@ -1,4 +1,4 @@
-length_and_then in winnow::binary - Rust
    
+length_and_then in winnow::binary - Rust
    
     
    Function winnow::binary::length_and_then
    source · 
    pub fn length_and_then<Input, Output, Count, Error, CountParser, ParseNext>(
     count: CountParser,
     parser: ParseNext
diff --git a/winnow/binary/fn.length_repeat.html b/winnow/binary/fn.length_repeat.html
index e2e2050bf..e4bb98e9a 100644
--- a/winnow/binary/fn.length_repeat.html
+++ b/winnow/binary/fn.length_repeat.html
@@ -1,4 +1,4 @@
-length_repeat in winnow::binary - Rust
    
+length_repeat in winnow::binary - Rust
    
     
    Function winnow::binary::length_repeat
    source · 
    pub fn length_repeat<Input, Output, Accumulator, Count, Error, CountParser, ParseNext>(
     count: CountParser,
     parser: ParseNext
diff --git a/winnow/binary/fn.length_take.html b/winnow/binary/fn.length_take.html
index 529bb9140..24d4b2694 100644
--- a/winnow/binary/fn.length_take.html
+++ b/winnow/binary/fn.length_take.html
@@ -1,4 +1,4 @@
-length_take in winnow::binary - Rust
    
+length_take in winnow::binary - Rust
    
     
    Function winnow::binary::length_take
    source · 
    pub fn length_take<Input, Count, Error, CountParser>(
     count: CountParser
 ) -> impl Parser<Input, <Input as Stream>::Slice, Error>
    where
diff --git a/winnow/binary/fn.u128.html b/winnow/binary/fn.u128.html
index f62bbb2f6..1692a6353 100644
--- a/winnow/binary/fn.u128.html
+++ b/winnow/binary/fn.u128.html
@@ -1,4 +1,4 @@
-u128 in winnow::binary - Rust
    
+u128 in winnow::binary - Rust
    
     
    Function winnow::binary::u128
    source · 
    pub fn u128<Input, Error>(endian: Endianness) -> impl Parser<Input, u128, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.u16.html b/winnow/binary/fn.u16.html
index c187e6b33..55a3b784d 100644
--- a/winnow/binary/fn.u16.html
+++ b/winnow/binary/fn.u16.html
@@ -1,4 +1,4 @@
-u16 in winnow::binary - Rust
    
+u16 in winnow::binary - Rust
    
     
    Function winnow::binary::u16
    source · 
    pub fn u16<Input, Error>(endian: Endianness) -> impl Parser<Input, u16, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.u24.html b/winnow/binary/fn.u24.html
index ff94fece5..2333bd043 100644
--- a/winnow/binary/fn.u24.html
+++ b/winnow/binary/fn.u24.html
@@ -1,4 +1,4 @@
-u24 in winnow::binary - Rust
    
+u24 in winnow::binary - Rust
    
     
    Function winnow::binary::u24
    source · 
    pub fn u24<Input, Error>(endian: Endianness) -> impl Parser<Input, u32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.u32.html b/winnow/binary/fn.u32.html
index 0876e5743..31bd1732f 100644
--- a/winnow/binary/fn.u32.html
+++ b/winnow/binary/fn.u32.html
@@ -1,4 +1,4 @@
-u32 in winnow::binary - Rust
    
+u32 in winnow::binary - Rust
    
     
    Function winnow::binary::u32
    source · 
    pub fn u32<Input, Error>(endian: Endianness) -> impl Parser<Input, u32, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.u64.html b/winnow/binary/fn.u64.html
index 6b74cc3e2..c3aec2397 100644
--- a/winnow/binary/fn.u64.html
+++ b/winnow/binary/fn.u64.html
@@ -1,4 +1,4 @@
-u64 in winnow::binary - Rust
    
+u64 in winnow::binary - Rust
    
     
    Function winnow::binary::u64
    source · 
    pub fn u64<Input, Error>(endian: Endianness) -> impl Parser<Input, u64, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     <Input as Stream>::Slice: AsBytes,
diff --git a/winnow/binary/fn.u8.html b/winnow/binary/fn.u8.html
index db27901da..c466ce7c6 100644
--- a/winnow/binary/fn.u8.html
+++ b/winnow/binary/fn.u8.html
@@ -1,4 +1,4 @@
-u8 in winnow::binary - Rust
    
+u8 in winnow::binary - Rust
    
     
    Function winnow::binary::u8
    source · 
    pub fn u8<Input, Error>(input: &mut Input) -> PResult<u8, Error>
    where
     Input: StreamIsPartial + Stream<Token = u8>,
     Error: ParserError<Input>,
    Expand description
    Recognizes an unsigned 1 byte integer
    
diff --git a/winnow/binary/index.html b/winnow/binary/index.html
index 431f75927..91667049b 100644
--- a/winnow/binary/index.html
+++ b/winnow/binary/index.html
@@ -1,3 +1,3 @@
-winnow::binary - Rust
    
+winnow::binary - Rust
    
     
    Module winnow::binary
    source · 
    Expand description
    Parsers recognizing numbers
    
 
    Modules§
    • bits
      Bit level parsers
    Enums§
    Functions§
    • be_f32
      Recognizes a big endian 4 bytes floating point number.
    • be_f64
      Recognizes a big endian 8 bytes floating point number.
    • be_i8
      Recognizes a signed 1 byte integer.
    • be_i16
      Recognizes a big endian signed 2 bytes integer.
    • be_i24
      Recognizes a big endian signed 3 bytes integer.
    • be_i32
      Recognizes a big endian signed 4 bytes integer.
    • be_i64
      Recognizes a big endian signed 8 bytes integer.
    • be_i128
      Recognizes a big endian signed 16 bytes integer.
    • be_u8
      Recognizes an unsigned 1 byte integer.
    • be_u16
      Recognizes a big endian unsigned 2 bytes integer.
    • be_u24
      Recognizes a big endian unsigned 3 byte integer.
    • be_u32
      Recognizes a big endian unsigned 4 bytes integer.
    • be_u64
      Recognizes a big endian unsigned 8 bytes integer.
    • be_u128
      Recognizes a big endian unsigned 16 bytes integer.
    • f32
      Recognizes a 4 byte floating point number
    • f64
      Recognizes an 8 byte floating point number
    • i8
      Recognizes a signed 1 byte integer
    • i16
      Recognizes a signed 2 byte integer
    • i24
      Recognizes a signed 3 byte integer
    • i32
      Recognizes a signed 4 byte integer
    • i64
      Recognizes a signed 8 byte integer
    • i128
      Recognizes a signed 16 byte integer
    • le_f32
      Recognizes a little endian 4 bytes floating point number.
    • le_f64
      Recognizes a little endian 8 bytes floating point number.
    • le_i8
      Recognizes a signed 1 byte integer.
    • le_i16
      Recognizes a little endian signed 2 bytes integer.
    • le_i24
      Recognizes a little endian signed 3 bytes integer.
    • le_i32
      Recognizes a little endian signed 4 bytes integer.
    • le_i64
      Recognizes a little endian signed 8 bytes integer.
    • le_i128
      Recognizes a little endian signed 16 bytes integer.
    • le_u8
      Recognizes an unsigned 1 byte integer.
    • le_u16
      Recognizes a little endian unsigned 2 bytes integer.
    • le_u24
      Recognizes a little endian unsigned 3 byte integer.
    • le_u32
      Recognizes a little endian unsigned 4 bytes integer.
    • le_u64
      Recognizes a little endian unsigned 8 bytes integer.
    • le_u128
      Recognizes a little endian unsigned 16 bytes integer.
    • length_and_then
      Parse a length-prefixed slice (TLV)
    • length_repeat
      Accumulate a length-prefixed sequence of values (TLV)
    • length_take
      Get a length-prefixed slice (TLV)
    • u8
      Recognizes an unsigned 1 byte integer
    • u16
      Recognizes an unsigned 2 bytes integer
    • u24
      Recognizes an unsigned 3 byte integer
    • u32
      Recognizes an unsigned 4 byte integer
    • u64
      Recognizes an unsigned 8 byte integer
    • u128
      Recognizes an unsigned 16 byte integer
    
\ No newline at end of file
diff --git a/winnow/combinator/fn.alt.html b/winnow/combinator/fn.alt.html
index 330c243b1..114eba9a3 100644
--- a/winnow/combinator/fn.alt.html
+++ b/winnow/combinator/fn.alt.html
@@ -1,4 +1,4 @@
-alt in winnow::combinator - Rust
    
+alt in winnow::combinator - Rust
    
     
    Function winnow::combinator::alt
    source · 
    pub fn alt<Input: Stream, Output, Error, Alternatives>(
     alternatives: Alternatives
 ) -> impl Parser<Input, Output, Error>
    where
diff --git a/winnow/combinator/fn.backtrack_err.html b/winnow/combinator/fn.backtrack_err.html
index 23404f6fe..a6cc7b36e 100644
--- a/winnow/combinator/fn.backtrack_err.html
+++ b/winnow/combinator/fn.backtrack_err.html
@@ -1,4 +1,4 @@
-backtrack_err in winnow::combinator - Rust
    
+backtrack_err in winnow::combinator - Rust
    
     
    Function winnow::combinator::backtrack_err
    source · 
    pub fn backtrack_err<Input, Output, Error, ParseNext>(
     parser: ParseNext
 ) -> impl Parser<Input, Output, Error>
    where
diff --git a/winnow/combinator/fn.cond.html b/winnow/combinator/fn.cond.html
index ea419cedd..93e852b3e 100644
--- a/winnow/combinator/fn.cond.html
+++ b/winnow/combinator/fn.cond.html
@@ -1,4 +1,4 @@
-cond in winnow::combinator - Rust
    
+cond in winnow::combinator - Rust
    
     
    Function winnow::combinator::cond
    source · 
    pub fn cond<Input, Output, Error, ParseNext>(
     cond: bool,
     parser: ParseNext
diff --git a/winnow/combinator/fn.cut_err.html b/winnow/combinator/fn.cut_err.html
index 92c692779..03276344a 100644
--- a/winnow/combinator/fn.cut_err.html
+++ b/winnow/combinator/fn.cut_err.html
@@ -1,4 +1,4 @@
-cut_err in winnow::combinator - Rust
    
+cut_err in winnow::combinator - Rust
    
     
    Function winnow::combinator::cut_err
    source · 
    pub fn cut_err<Input, Output, Error, ParseNext>(
     parser: ParseNext
 ) -> impl Parser<Input, Output, Error>
    where
diff --git a/winnow/combinator/fn.delimited.html b/winnow/combinator/fn.delimited.html
index 9f42ad277..e0861239a 100644
--- a/winnow/combinator/fn.delimited.html
+++ b/winnow/combinator/fn.delimited.html
@@ -1,4 +1,4 @@
-delimited in winnow::combinator - Rust
    
+delimited in winnow::combinator - Rust
    
     
    Function winnow::combinator::delimited
    source · 
    pub fn delimited<Input, Ignored1, Output, Ignored2, Error, IgnoredParser1, ParseNext, IgnoredParser2>(
     ignored1: IgnoredParser1,
     parser: ParseNext,
diff --git a/winnow/combinator/fn.empty.html b/winnow/combinator/fn.empty.html
index 5750756c8..41ac3cb13 100644
--- a/winnow/combinator/fn.empty.html
+++ b/winnow/combinator/fn.empty.html
@@ -1,4 +1,4 @@
-empty in winnow::combinator - Rust
    
+empty in winnow::combinator - Rust
    
     
    Function winnow::combinator::empty
    source · 
    pub fn empty<Input, Error>(_input: &mut Input) -> PResult<(), Error>
    where
     Input: Stream,
     Error: ParserError<Input>,
    Expand description
    Succeed, consuming no input
    
diff --git a/winnow/combinator/fn.eof.html b/winnow/combinator/fn.eof.html
index c3fe6ea28..64dff7b2a 100644
--- a/winnow/combinator/fn.eof.html
+++ b/winnow/combinator/fn.eof.html
@@ -1,4 +1,4 @@
-eof in winnow::combinator - Rust
    
+eof in winnow::combinator - Rust
    
     
    Function winnow::combinator::eof
    source · 
    pub fn eof<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
    where
diff --git a/winnow/combinator/fn.fail.html b/winnow/combinator/fn.fail.html
index e93bcfd6f..4625acdaf 100644
--- a/winnow/combinator/fn.fail.html
+++ b/winnow/combinator/fn.fail.html
@@ -1,4 +1,4 @@
-fail in winnow::combinator - Rust
    
+fail in winnow::combinator - Rust
    
     
    Function winnow::combinator::fail
    source · 
    pub fn fail<Input, Output, Error>(i: &mut Input) -> PResult<Output, Error>
    where
     Input: Stream,
     Error: ParserError<Input>,
    Expand description
    A parser which always fails.
    
diff --git a/winnow/combinator/fn.fill.html b/winnow/combinator/fn.fill.html
index ba6622034..683ed2be9 100644
--- a/winnow/combinator/fn.fill.html
+++ b/winnow/combinator/fn.fill.html
@@ -1,4 +1,4 @@
-fill in winnow::combinator - Rust
    
+fill in winnow::combinator - Rust
    
     
    Function winnow::combinator::fill
    source · 
    pub fn fill<'i, Input, Output, Error, ParseNext>(
     parser: ParseNext,
     buf: &'i mut [Output]
diff --git a/winnow/combinator/fn.iterator.html b/winnow/combinator/fn.iterator.html
index c8bd17ce8..7b26a1d27 100644
--- a/winnow/combinator/fn.iterator.html
+++ b/winnow/combinator/fn.iterator.html
@@ -1,4 +1,4 @@
-iterator in winnow::combinator - Rust
    
+iterator in winnow::combinator - Rust
    
     
    Function winnow::combinator::iterator
    source · 
    pub fn iterator<Input, Output, Error, ParseNext>(
     input: Input,
     parser: ParseNext
diff --git a/winnow/combinator/fn.not.html b/winnow/combinator/fn.not.html
index 9bd2be119..d5fa27c0e 100644
--- a/winnow/combinator/fn.not.html
+++ b/winnow/combinator/fn.not.html
@@ -1,4 +1,4 @@
-not in winnow::combinator - Rust
    
+not in winnow::combinator - Rust
    
     
    Function winnow::combinator::not
    source · 
    pub fn not<Input, Output, Error, ParseNext>(
     parser: ParseNext
 ) -> impl Parser<Input, (), Error>
    where
diff --git a/winnow/combinator/fn.opt.html b/winnow/combinator/fn.opt.html
index 0618f7915..2f101b993 100644
--- a/winnow/combinator/fn.opt.html
+++ b/winnow/combinator/fn.opt.html
@@ -1,4 +1,4 @@
-opt in winnow::combinator - Rust
    
+opt in winnow::combinator - Rust
    
     
    Function winnow::combinator::opt
    source · 
    pub fn opt<Input: Stream, Output, Error, ParseNext>(
     parser: ParseNext
 ) -> impl Parser<Input, Option<Output>, Error>
    where
diff --git a/winnow/combinator/fn.peek.html b/winnow/combinator/fn.peek.html
index 9e9e91280..b15969111 100644
--- a/winnow/combinator/fn.peek.html
+++ b/winnow/combinator/fn.peek.html
@@ -1,4 +1,4 @@
-peek in winnow::combinator - Rust
    
+peek in winnow::combinator - Rust
    
     
    Function winnow::combinator::peek
    source · 
    pub fn peek<Input, Output, Error, ParseNext>(
     parser: ParseNext
 ) -> impl Parser<Input, Output, Error>
    where
diff --git a/winnow/combinator/fn.permutation.html b/winnow/combinator/fn.permutation.html
index bf0d6e59c..75305e38b 100644
--- a/winnow/combinator/fn.permutation.html
+++ b/winnow/combinator/fn.permutation.html
@@ -1,4 +1,4 @@
-permutation in winnow::combinator - Rust
    
+permutation in winnow::combinator - Rust
    
     
    Function winnow::combinator::permutation
    source · 
    pub fn permutation<I: Stream, O, E: ParserError<I>, List: Permutation<I, O, E>>(
     l: List
 ) -> impl Parser<I, O, E>
    Expand description
    Applies a list of parsers in any order.
    
diff --git a/winnow/combinator/fn.preceded.html b/winnow/combinator/fn.preceded.html
index 73273ee07..3c44efeec 100644
--- a/winnow/combinator/fn.preceded.html
+++ b/winnow/combinator/fn.preceded.html
@@ -1,4 +1,4 @@
-preceded in winnow::combinator - Rust
    
+preceded in winnow::combinator - Rust
    
     
    Function winnow::combinator::preceded
    source · 
    pub fn preceded<Input, Ignored, Output, Error, IgnoredParser, ParseNext>(
     ignored: IgnoredParser,
     parser: ParseNext
diff --git a/winnow/combinator/fn.repeat.html b/winnow/combinator/fn.repeat.html
index b4384f196..d8abb682d 100644
--- a/winnow/combinator/fn.repeat.html
+++ b/winnow/combinator/fn.repeat.html
@@ -1,4 +1,4 @@
-repeat in winnow::combinator - Rust
    
+repeat in winnow::combinator - Rust
    
     
    Function winnow::combinator::repeat
    source · 
    pub fn repeat<Input, Output, Accumulator, Error, ParseNext>(
     occurrences: impl Into<Range>,
     parser: ParseNext
diff --git a/winnow/combinator/fn.repeat_till.html b/winnow/combinator/fn.repeat_till.html
index eb395d1a0..937bd9550 100644
--- a/winnow/combinator/fn.repeat_till.html
+++ b/winnow/combinator/fn.repeat_till.html
@@ -1,4 +1,4 @@
-repeat_till in winnow::combinator - Rust
    
+repeat_till in winnow::combinator - Rust
    
     
    Function winnow::combinator::repeat_till
    source · 
    pub fn repeat_till<Input, Output, Accumulator, Terminator, Error, ParseNext, TerminatorParser>(
     occurrences: impl Into<Range>,
     parse: ParseNext,
diff --git a/winnow/combinator/fn.rest.html b/winnow/combinator/fn.rest.html
index 2fa883028..ca7835cd3 100644
--- a/winnow/combinator/fn.rest.html
+++ b/winnow/combinator/fn.rest.html
@@ -1,4 +1,4 @@
-rest in winnow::combinator - Rust
    
+rest in winnow::combinator - Rust
    
     
    Function winnow::combinator::rest
    source · 
    pub fn rest<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Slice, Error>
    where
diff --git a/winnow/combinator/fn.rest_len.html b/winnow/combinator/fn.rest_len.html
index 82a09886c..4c92eec77 100644
--- a/winnow/combinator/fn.rest_len.html
+++ b/winnow/combinator/fn.rest_len.html
@@ -1,4 +1,4 @@
-rest_len in winnow::combinator - Rust
    
+rest_len in winnow::combinator - Rust
    
     
    Function winnow::combinator::rest_len
    source · 
    pub fn rest_len<Input, Error>(input: &mut Input) -> PResult<usize, Error>
    where
     Input: Stream,
     Error: ParserError<Input>,
    Expand description
    Return the length of the remaining input.
    
diff --git a/winnow/combinator/fn.separated.html b/winnow/combinator/fn.separated.html
index c875896b5..d1e926e15 100644
--- a/winnow/combinator/fn.separated.html
+++ b/winnow/combinator/fn.separated.html
@@ -1,4 +1,4 @@
-separated in winnow::combinator - Rust
    
+separated in winnow::combinator - Rust
    
     
    Function winnow::combinator::separated
    source · 
    pub fn separated<Input, Output, Accumulator, Sep, Error, ParseNext, SepParser>(
     occurrences: impl Into<Range>,
     parser: ParseNext,
diff --git a/winnow/combinator/fn.separated_foldl1.html b/winnow/combinator/fn.separated_foldl1.html
index 5dfd99ba7..927cce956 100644
--- a/winnow/combinator/fn.separated_foldl1.html
+++ b/winnow/combinator/fn.separated_foldl1.html
@@ -1,4 +1,4 @@
-separated_foldl1 in winnow::combinator - Rust
    
+separated_foldl1 in winnow::combinator - Rust
    
     
    Function winnow::combinator::separated_foldl1
    source · 
    pub fn separated_foldl1<Input, Output, Sep, Error, ParseNext, SepParser, Op>(
     parser: ParseNext,
     sep: SepParser,
diff --git a/winnow/combinator/fn.separated_foldr1.html b/winnow/combinator/fn.separated_foldr1.html
index 71c589475..59b2d5467 100644
--- a/winnow/combinator/fn.separated_foldr1.html
+++ b/winnow/combinator/fn.separated_foldr1.html
@@ -1,4 +1,4 @@
-separated_foldr1 in winnow::combinator - Rust
    
+separated_foldr1 in winnow::combinator - Rust
    
     
    Function winnow::combinator::separated_foldr1
    source · 
    pub fn separated_foldr1<Input, Output, Sep, Error, ParseNext, SepParser, Op>(
     parser: ParseNext,
     sep: SepParser,
diff --git a/winnow/combinator/fn.separated_pair.html b/winnow/combinator/fn.separated_pair.html
index df202f0f1..ab4c2d2b9 100644
--- a/winnow/combinator/fn.separated_pair.html
+++ b/winnow/combinator/fn.separated_pair.html
@@ -1,4 +1,4 @@
-separated_pair in winnow::combinator - Rust
    
+separated_pair in winnow::combinator - Rust
    
     
    Function winnow::combinator::separated_pair
    source · 
    pub fn separated_pair<Input, O1, Sep, O2, Error, P1, SepParser, P2>(
     first: P1,
     sep: SepParser,
diff --git a/winnow/combinator/fn.terminated.html b/winnow/combinator/fn.terminated.html
index 6d4f6425b..031aa4412 100644
--- a/winnow/combinator/fn.terminated.html
+++ b/winnow/combinator/fn.terminated.html
@@ -1,4 +1,4 @@
-terminated in winnow::combinator - Rust
    
+terminated in winnow::combinator - Rust
    
     
    Function winnow::combinator::terminated
    source · 
    pub fn terminated<Input, Output, Ignored, Error, ParseNext, IgnoredParser>(
     parser: ParseNext,
     ignored: IgnoredParser
diff --git a/winnow/combinator/fn.todo.html b/winnow/combinator/fn.todo.html
index 0ba58d87e..97a7cacc0 100644
--- a/winnow/combinator/fn.todo.html
+++ b/winnow/combinator/fn.todo.html
@@ -1,4 +1,4 @@
-todo in winnow::combinator - Rust
    
+todo in winnow::combinator - Rust
    
     
    Function winnow::combinator::todo
    source · 
    pub fn todo<Input, Output, Error>(input: &mut Input) -> PResult<Output, Error>
    where
     Input: Stream,
    Expand description
    A placeholder for a not-yet-implemented Parser
    
 
    This is analogous to the todo! macro and helps with prototyping.
    
diff --git a/winnow/combinator/fn.trace.html b/winnow/combinator/fn.trace.html
index ec2b6b991..56eb7efa2 100644
--- a/winnow/combinator/fn.trace.html
+++ b/winnow/combinator/fn.trace.html
@@ -1,5 +1,5 @@
-trace in winnow::combinator - Rust
    
-    
    Function winnow::combinator::trace
    source · 
    pub fn trace<I: Stream, O, E>(
+trace in winnow::combinator - Rust
    
+    
    Function winnow::combinator::trace
    source · 
    pub fn trace<I: Stream, O, E>(
     name: impl Display,
     parser: impl Parser<I, O, E>
 ) -> impl Parser<I, O, E>
    Expand description
    Trace the execution of the parser
    
diff --git a/winnow/combinator/index.html b/winnow/combinator/index.html
index cc5af9cee..155bfad1e 100644
--- a/winnow/combinator/index.html
+++ b/winnow/combinator/index.html
@@ -1,4 +1,4 @@
-winnow::combinator - Rust
    
+winnow::combinator - Rust
    
     
    Module winnow::combinator
    source · 
    Expand description
    §List of parsers and combinators
    
 
    Note: this list is meant to provide a nicer way to find a parser than reading through the documentation on docs.rs. Function combinators are organized in module so they are a bit easier to find.
    
 
    §Basic elements
    
@@ -180,5 +180,5 @@ little endian i16 integer.
 
  • pattern: Check if a set number of bits matches a pattern
    • 
 
  • bool: Match any one bit
    • 
 
-
    Macros§
    • dispatch
      match for parsers
    • seq
      Initialize a struct or tuple out of a sequences of parsers
    Structs§
    Traits§
    Functions§
    Macros§
    • dispatch
      match for parsers
    • seq
      Initialize a struct or tuple out of a sequences of parsers
    Structs§
    Traits§
    Functions§
    
\ No newline at end of file
diff --git a/winnow/combinator/macro.dispatch.html b/winnow/combinator/macro.dispatch.html
index e57afe14f..3f69e2bc4 100644
--- a/winnow/combinator/macro.dispatch.html
+++ b/winnow/combinator/macro.dispatch.html
@@ -1,4 +1,4 @@
-dispatch in winnow::combinator - Rust
    
+dispatch in winnow::combinator - Rust
    
     
    Macro winnow::combinator::dispatch
    source · 
    macro_rules! dispatch {
     ($match_parser: expr; $( $pat:pat $(if $pred:expr)? => $expr: expr ),+ $(,)? ) => { ... };
 }
    Expand description
    match for parsers
    
diff --git a/winnow/combinator/macro.seq.html b/winnow/combinator/macro.seq.html
index 3ee76e198..e42bf0c01 100644
--- a/winnow/combinator/macro.seq.html
+++ b/winnow/combinator/macro.seq.html
@@ -1,4 +1,4 @@
-seq in winnow::combinator - Rust
    
+seq in winnow::combinator - Rust
    
     
    Macro winnow::combinator::seq
    source · 
    macro_rules! seq {
     ($name: ident { $($fields: tt)* }) => { ... };
     ($name: ident ( $($elements: tt)* )) => { ... };
diff --git a/winnow/combinator/struct.AndThen.html b/winnow/combinator/struct.AndThen.html
index 8ed65fb9c..175aa04f5 100644
--- a/winnow/combinator/struct.AndThen.html
+++ b/winnow/combinator/struct.AndThen.html
@@ -1,40 +1,40 @@
-AndThen in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::AndThen
    source · 
    pub struct AndThen<F, G, I, O, O2, E>
    where
+AndThen in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::AndThen
    source · 
    pub struct AndThen<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: Parser<O, O2, E>,
     O: StreamIsPartial,
     I: Stream,
    { /* private fields */ }
    Expand description
    Implementation of Parser::and_then
    
-
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O2, E> for AndThen<F, G, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O2, E> for AndThen<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: Parser<O, O2, E>,
     O: StreamIsPartial,
-    I: Stream,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    I: Stream,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, G, I, O, O2, E> Freeze for AndThen<F, G, I, O, O2, E>
    where
     F: Freeze,
diff --git a/winnow/combinator/struct.ByRef.html b/winnow/combinator/struct.ByRef.html
index 681f2cf34..c2f9940e2 100644
--- a/winnow/combinator/struct.ByRef.html
+++ b/winnow/combinator/struct.ByRef.html
@@ -1,21 +1,21 @@
-ByRef in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::ByRef
    source · 
    pub struct ByRef<'p, P> { /* private fields */ }
    Expand description
    Implementation of Parser::by_ref
    
-
    Trait Implementations§
    source§
    impl<'p, I, O, E, P> Parser<I, O, E> for ByRef<'p, P>
    where
-    P: Parser<I, O, E>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+ByRef in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::ByRef
    source · 
    pub struct ByRef<'p, P> { /* private fields */ }
    Expand description
    Implementation of Parser::by_ref
    
+
    Trait Implementations§
    source§
    impl<'p, I, O, E, P> Parser<I, O, E> for ByRef<'p, P>
    where
+    P: Parser<I, O, E>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<'p, P> Freeze for ByRef<'p, P>
    §
    impl<'p, P> RefUnwindSafe for ByRef<'p, P>
    where
     P: RefUnwindSafe,
    §
    impl<'p, P> Send for ByRef<'p, P>
    where
diff --git a/winnow/combinator/struct.CompleteErr.html b/winnow/combinator/struct.CompleteErr.html
index e9f08246c..fc2d899fd 100644
--- a/winnow/combinator/struct.CompleteErr.html
+++ b/winnow/combinator/struct.CompleteErr.html
@@ -1,49 +1,49 @@
-CompleteErr in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::CompleteErr
    source · 
    pub struct CompleteErr<F> { /* private fields */ }
    Expand description
    Implementation of Parser::complete_err
    
-
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, O, E> for CompleteErr<F>
    where
+CompleteErr in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::CompleteErr
    source · 
    pub struct CompleteErr<F> { /* private fields */ }
    Expand description
    Implementation of Parser::complete_err
    
+
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, O, E> for CompleteErr<F>
    where
     I: Stream,
     F: Parser<I, O, E>,
-    E: ParserError<I>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    E: ParserError<I>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F> Freeze for CompleteErr<F>
    where
     F: Freeze,
    §
    impl<F> RefUnwindSafe for CompleteErr<F>
    where
diff --git a/winnow/combinator/struct.Context.html b/winnow/combinator/struct.Context.html
index 0efca3824..75b6a8f64 100644
--- a/winnow/combinator/struct.Context.html
+++ b/winnow/combinator/struct.Context.html
@@ -1,40 +1,40 @@
-Context in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::Context
    source · 
    pub struct Context<F, I, O, E, C>
    where
+Context in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::Context
    source · 
    pub struct Context<F, I, O, E, C>
    where
     F: Parser<I, O, E>,
     I: Stream,
     E: AddContext<I, C>,
     C: Clone + Debug,
    { /* private fields */ }
    Expand description
    Implementation of Parser::context
    
-
    Trait Implementations§
    source§
    impl<F, I, O, E, C> Parser<I, O, E> for Context<F, I, O, E, C>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, E, C> Parser<I, O, E> for Context<F, I, O, E, C>
    where
     F: Parser<I, O, E>,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    C: Clone + Debug,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, E, C> Freeze for Context<F, I, O, E, C>
    where
     C: Freeze,
diff --git a/winnow/combinator/struct.DefaultValue.html b/winnow/combinator/struct.DefaultValue.html
index d104b9a58..29110ec88 100644
--- a/winnow/combinator/struct.DefaultValue.html
+++ b/winnow/combinator/struct.DefaultValue.html
@@ -1,24 +1,24 @@
-DefaultValue in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::DefaultValue
    source · 
    pub struct DefaultValue<F, I, O, O2, E>
    where
+DefaultValue in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::DefaultValue
    source · 
    pub struct DefaultValue<F, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     O2: Default,
    { /* private fields */ }
    Expand description
    Implementation of Parser::default_value
    
-
    Trait Implementations§
    source§
    impl<F, I, O, O2, E> Parser<I, O2, E> for DefaultValue<F, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, O2, E> Parser<I, O2, E> for DefaultValue<F, I, O, O2, E>
    where
     F: Parser<I, O, E>,
-    O2: Default,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    O2: Default,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, O2, E> Freeze for DefaultValue<F, I, O, O2, E>
    where
     F: Freeze,
    §
    impl<F, I, O, O2, E> RefUnwindSafe for DefaultValue<F, I, O, O2, E>
    where
diff --git a/winnow/combinator/struct.ErrInto.html b/winnow/combinator/struct.ErrInto.html
index 87655d16c..045259f04 100644
--- a/winnow/combinator/struct.ErrInto.html
+++ b/winnow/combinator/struct.ErrInto.html
@@ -1,24 +1,24 @@
-ErrInto in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::ErrInto
    source · 
    pub struct ErrInto<F, I, O, E, E2>
    where
+ErrInto in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::ErrInto
    source · 
    pub struct ErrInto<F, I, O, E, E2>
    where
     F: Parser<I, O, E>,
     E: Into<E2>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::err_into
    
-
    Trait Implementations§
    source§
    impl<F, I, O, E, E2> Parser<I, O, E2> for ErrInto<F, I, O, E, E2>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, E, E2> Parser<I, O, E2> for ErrInto<F, I, O, E, E2>
    where
     F: Parser<I, O, E>,
-    E: Into<E2>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O, E2>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    E: Into<E2>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O, E2>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, E, E2> Freeze for ErrInto<F, I, O, E, E2>
    where
     F: Freeze,
    §
    impl<F, I, O, E, E2> RefUnwindSafe for ErrInto<F, I, O, E, E2>
    where
diff --git a/winnow/combinator/struct.FlatMap.html b/winnow/combinator/struct.FlatMap.html
index b9b83c4a9..67fd6d329 100644
--- a/winnow/combinator/struct.FlatMap.html
+++ b/winnow/combinator/struct.FlatMap.html
@@ -1,26 +1,26 @@
-FlatMap in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::FlatMap
    source · 
    pub struct FlatMap<F, G, H, I, O, O2, E>
    where
+FlatMap in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::FlatMap
    source · 
    pub struct FlatMap<F, G, H, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: FnMut(O) -> H,
     H: Parser<I, O2, E>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::flat_map
    
-
    Trait Implementations§
    source§
    impl<F, G, H, I, O, O2, E> Parser<I, O2, E> for FlatMap<F, G, H, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, G, H, I, O, O2, E> Parser<I, O2, E> for FlatMap<F, G, H, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, G, H, I, O, O2, E> Freeze for FlatMap<F, G, H, I, O, O2, E>
    where
     F: Freeze,
diff --git a/winnow/combinator/struct.Map.html b/winnow/combinator/struct.Map.html
index 15336a465..c086643ae 100644
--- a/winnow/combinator/struct.Map.html
+++ b/winnow/combinator/struct.Map.html
@@ -1,24 +1,24 @@
-Map in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::Map
    source · 
    pub struct Map<F, G, I, O, O2, E>
    where
+Map in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::Map
    source · 
    pub struct Map<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: FnMut(O) -> O2,
    { /* private fields */ }
    Expand description
    Implementation of Parser::map
    
-
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O2, E> for Map<F, G, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O2, E> for Map<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
-    G: FnMut(O) -> O2,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    G: FnMut(O) -> O2,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, G, I, O, O2, E> Freeze for Map<F, G, I, O, O2, E>
    where
     F: Freeze,
diff --git a/winnow/combinator/struct.OutputInto.html b/winnow/combinator/struct.OutputInto.html
index ed86b194c..aafb96404 100644
--- a/winnow/combinator/struct.OutputInto.html
+++ b/winnow/combinator/struct.OutputInto.html
@@ -1,24 +1,24 @@
-OutputInto in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::OutputInto
    source · 
    pub struct OutputInto<F, I, O, O2, E>
    where
+OutputInto in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::OutputInto
    source · 
    pub struct OutputInto<F, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     O: Into<O2>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::output_into
    
-
    Trait Implementations§
    source§
    impl<F, I, O, O2, E> Parser<I, O2, E> for OutputInto<F, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, O2, E> Parser<I, O2, E> for OutputInto<F, I, O, O2, E>
    where
     F: Parser<I, O, E>,
-    O: Into<O2>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    O: Into<O2>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, O2, E> Freeze for OutputInto<F, I, O, O2, E>
    where
     F: Freeze,
    §
    impl<F, I, O, O2, E> RefUnwindSafe for OutputInto<F, I, O, O2, E>
    where
diff --git a/winnow/combinator/struct.ParseTo.html b/winnow/combinator/struct.ParseTo.html
index 6eae525e0..4b2f5f354 100644
--- a/winnow/combinator/struct.ParseTo.html
+++ b/winnow/combinator/struct.ParseTo.html
@@ -1,54 +1,54 @@
-ParseTo in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::ParseTo
    source · 
    pub struct ParseTo<P, I, O, O2, E>
    where
+ParseTo in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::ParseTo
    source · 
    pub struct ParseTo<P, I, O, O2, E>
    where
     P: Parser<I, O, E>,
     I: Stream,
     O: ParseSlice<O2>,
     E: ParserError<I>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::parse_to
    
-
    Trait Implementations§
    source§
    impl<P, I, O, O2, E> Parser<I, O2, E> for ParseTo<P, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<P, I, O, O2, E> Parser<I, O2, E> for ParseTo<P, I, O, O2, E>
    where
     P: Parser<I, O, E>,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    E: ParserError<I>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<P, I, O, O2, E> Freeze for ParseTo<P, I, O, O2, E>
    where
     P: Freeze,
    §
    impl<P, I, O, O2, E> RefUnwindSafe for ParseTo<P, I, O, O2, E>
    where
diff --git a/winnow/combinator/struct.ParserIterator.html b/winnow/combinator/struct.ParserIterator.html
index a768ed437..9f434c8d2 100644
--- a/winnow/combinator/struct.ParserIterator.html
+++ b/winnow/combinator/struct.ParserIterator.html
@@ -1,4 +1,4 @@
-ParserIterator in winnow::combinator - Rust
    
+ParserIterator in winnow::combinator - Rust
    
     
    Struct winnow::combinator::ParserIterator
    source · 
    pub struct ParserIterator<F, I, O, E>
    where
     F: Parser<I, O, E>,
     I: Stream,
    { /* private fields */ }
    Expand description
    Main structure associated to iterator.
    
@@ -12,51 +12,51 @@
 ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>
    where
     Self: Sized,
    🔬This is a nightly-only experimental API. (iter_next_chunk)
    Advances the iterator and returns an array containing the next N values. Read more
    1.0.0 · source§
    fn size_hint(&self) -> (usize, Option<usize>)
    Returns the bounds on the remaining length of the iterator. Read more
    1.0.0 · source§
    fn count(self) -> usize
    where
     Self: Sized,
    Consumes the iterator, counting the number of iterations and returning it. Read more
    1.0.0 · source§
    fn last(self) -> Option<Self::Item>
    where
-    Self: Sized,
    Consumes the iterator, returning the last element. Read more
    source§
    fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
    🔬This is a nightly-only experimental API. (iter_advance_by)
    Advances the iterator by n elements. Read more
    1.0.0 · source§
    fn nth(&mut self, n: usize) -> Option<Self::Item>
    Returns the nth element of the iterator. Read more
    1.28.0 · source§
    fn step_by(self, step: usize) -> StepBy<Self> ⓘ
    where
+    Self: Sized,
    Consumes the iterator, returning the last element. Read more
    source§
    fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
    🔬This is a nightly-only experimental API. (iter_advance_by)
    Advances the iterator by n elements. Read more
    1.0.0 · source§
    fn nth(&mut self, n: usize) -> Option<Self::Item>
    Returns the nth element of the iterator. Read more
    1.28.0 · source§
    fn step_by(self, step: usize) -> StepBy<Self>
    where
     Self: Sized,
    Creates an iterator starting at the same point, but stepping by
-the given amount at each iteration. Read more
    1.0.0 · source§
    fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> ⓘ
    where
+the given amount at each iteration. Read more
    1.0.0 · source§
    fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
    where
     Self: Sized,
-    U: IntoIterator<Item = Self::Item>,
    Takes two iterators and creates a new iterator over both in sequence. Read more
    1.0.0 · source§
    fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> ⓘ
    where
+    U: IntoIterator<Item = Self::Item>,
    Takes two iterators and creates a new iterator over both in sequence. Read more
    1.0.0 · source§
    fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>
    where
     Self: Sized,
-    U: IntoIterator,
    ‘Zips up’ two iterators into a single iterator of pairs. Read more
    source§
    fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> ⓘ
    where
+    U: IntoIterator,
    ‘Zips up’ two iterators into a single iterator of pairs. Read more
    source§
    fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
    where
     Self: Sized,
     G: FnMut() -> Self::Item,
    🔬This is a nightly-only experimental API. (iter_intersperse)
    Creates a new iterator which places an item generated by separator
-between adjacent items of the original iterator. Read more
    1.0.0 · source§
    fn map<B, F>(self, f: F) -> Map<Self, F> ⓘ
    where
+between adjacent items of the original iterator. Read more
    1.0.0 · source§
    fn map<B, F>(self, f: F) -> Map<Self, F>
    where
     Self: Sized,
     F: FnMut(Self::Item) -> B,
    Takes a closure and creates an iterator which calls that closure on each
 element. Read more
    1.21.0 · source§
    fn for_each<F>(self, f: F)
    where
     Self: Sized,
-    F: FnMut(Self::Item),
    Calls a closure on each element of an iterator. Read more
    1.0.0 · source§
    fn filter<P>(self, predicate: P) -> Filter<Self, P> ⓘ
    where
+    F: FnMut(Self::Item),
    Calls a closure on each element of an iterator. Read more
    1.0.0 · source§
    fn filter<P>(self, predicate: P) -> Filter<Self, P>
    where
     Self: Sized,
     P: FnMut(&Self::Item) -> bool,
    Creates an iterator which uses a closure to determine if an element
-should be yielded. Read more
    1.0.0 · source§
    fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> ⓘ
    where
+should be yielded. Read more
    1.0.0 · source§
    fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
    where
     Self: Sized,
-    F: FnMut(Self::Item) -> Option<B>,
    Creates an iterator that both filters and maps. Read more
    1.0.0 · source§
    fn enumerate(self) -> Enumerate<Self> ⓘ
    where
+    F: FnMut(Self::Item) -> Option<B>,
    Creates an iterator that both filters and maps. Read more
    1.0.0 · source§
    fn enumerate(self) -> Enumerate<Self>
    where
     Self: Sized,
    Creates an iterator which gives the current iteration count as well as
-the next value. Read more
    1.0.0 · source§
    fn peekable(self) -> Peekable<Self> ⓘ
    where
+the next value. Read more
    1.0.0 · source§
    fn peekable(self) -> Peekable<Self>
    where
     Self: Sized,
    Creates an iterator which can use the peek and peek_mut methods
 to look at the next element of the iterator without consuming it. See
-their documentation for more information. Read more
    1.0.0 · source§
    fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> ⓘ
    where
+their documentation for more information. Read more
    1.0.0 · source§
    fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
    where
     Self: Sized,
-    P: FnMut(&Self::Item) -> bool,
    Creates an iterator that skips elements based on a predicate. Read more
    1.0.0 · source§
    fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> ⓘ
    where
+    P: FnMut(&Self::Item) -> bool,
    Creates an iterator that skips elements based on a predicate. Read more
    1.0.0 · source§
    fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
    where
     Self: Sized,
-    P: FnMut(&Self::Item) -> bool,
    Creates an iterator that yields elements based on a predicate. Read more
    1.57.0 · source§
    fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> ⓘ
    where
+    P: FnMut(&Self::Item) -> bool,
    Creates an iterator that yields elements based on a predicate. Read more
    1.57.0 · source§
    fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
    where
     Self: Sized,
-    P: FnMut(Self::Item) -> Option<B>,
    Creates an iterator that both yields elements based on a predicate and maps. Read more
    1.0.0 · source§
    fn skip(self, n: usize) -> Skip<Self> ⓘ
    where
-    Self: Sized,
    Creates an iterator that skips the first n elements. Read more
    1.0.0 · source§
    fn take(self, n: usize) -> Take<Self> ⓘ
    where
+    P: FnMut(Self::Item) -> Option<B>,
    Creates an iterator that both yields elements based on a predicate and maps. Read more
    1.0.0 · source§
    fn skip(self, n: usize) -> Skip<Self>
    where
+    Self: Sized,
    Creates an iterator that skips the first n elements. Read more
    1.0.0 · source§
    fn take(self, n: usize) -> Take<Self>
    where
     Self: Sized,
    Creates an iterator that yields the first n elements, or fewer
-if the underlying iterator ends sooner. Read more
    1.0.0 · source§
    fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> ⓘ
    where
+if the underlying iterator ends sooner. Read more
    1.0.0 · source§
    fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
    where
     Self: Sized,
     F: FnMut(&mut St, Self::Item) -> Option<B>,
    An iterator adapter which, like fold, holds internal state, but
-unlike fold, produces a new iterator. Read more
    1.0.0 · source§
    fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> ⓘ
    where
+unlike fold, produces a new iterator. Read more
    1.0.0 · source§
    fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
    where
     Self: Sized,
     U: IntoIterator,
-    F: FnMut(Self::Item) -> U,
    Creates an iterator that works like map, but flattens nested structure. Read more
    source§
    fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N> ⓘ
    where
+    F: FnMut(Self::Item) -> U,
    Creates an iterator that works like map, but flattens nested structure. Read more
    source§
    fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
    where
     Self: Sized,
     F: FnMut(&[Self::Item; N]) -> R,
    🔬This is a nightly-only experimental API. (iter_map_windows)
    Calls the given function f for each contiguous window of size N over
 self and returns an iterator over the outputs of f. Like slice::windows(),
-the windows during mapping overlap as well. Read more
    1.0.0 · source§
    fn fuse(self) -> Fuse<Self> ⓘ
    where
-    Self: Sized,
    Creates an iterator which ends after the first None. Read more
    1.0.0 · source§
    fn inspect<F>(self, f: F) -> Inspect<Self, F> ⓘ
    where
+the windows during mapping overlap as well. Read more
    1.0.0 · source§
    fn fuse(self) -> Fuse<Self>
    where
+    Self: Sized,
    Creates an iterator which ends after the first None. Read more
    1.0.0 · source§
    fn inspect<F>(self, f: F) -> Inspect<Self, F>
    where
     Self: Sized,
     F: FnMut(&Self::Item),
    Does something with each element of an iterator, passing the value on. Read more
    1.0.0 · source§
    fn by_ref(&mut self) -> &mut Self
    where
     Self: Sized,
    Borrows an iterator, rather than consuming it. Read more
    1.0.0 · source§
    fn collect<B>(self) -> B
    where
@@ -127,11 +127,11 @@ specified function. Read more
    1.0.0 · source§
    fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
    where
     FromA: Default + Extend<A>,
     FromB: Default + Extend<B>,
-    Self: Sized + Iterator<Item = (A, B)>,
    Converts an iterator of pairs into a pair of containers. Read more
    1.36.0 · source§
    fn copied<'a, T>(self) -> Copied<Self> ⓘ
    where
+    Self: Sized + Iterator<Item = (A, B)>,
    Converts an iterator of pairs into a pair of containers. Read more
    1.36.0 · source§
    fn copied<'a, T>(self) -> Copied<Self>
    where
     T: 'a + Copy,
-    Self: Sized + Iterator<Item = &'a T>,
    Creates an iterator which copies all of its elements. Read more
    1.0.0 · source§
    fn cloned<'a, T>(self) -> Cloned<Self> ⓘ
    where
+    Self: Sized + Iterator<Item = &'a T>,
    Creates an iterator which copies all of its elements. Read more
    1.0.0 · source§
    fn cloned<'a, T>(self) -> Cloned<Self>
    where
     T: 'a + Clone,
-    Self: Sized + Iterator<Item = &'a T>,
    Creates an iterator which clones all of its elements. Read more
    source§
    fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N> ⓘ
    where
+    Self: Sized + Iterator<Item = &'a T>,
    Creates an iterator which clones all of its elements. Read more
    source§
    fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>
    where
     Self: Sized,
    🔬This is a nightly-only experimental API. (iter_array_chunks)
    Returns an iterator over N elements of the iterator at a time. Read more
    1.11.0 · source§
    fn sum<S>(self) -> S
    where
     Self: Sized,
     S: Sum<Self::Item>,
    Sums the elements of an iterator. Read more
    1.11.0 · source§
    fn product<P>(self) -> P
    where
@@ -217,4 +217,4 @@ function. From<T> for U chooses to do.
    
 
    source§
    impl<T, U> TryFrom<U> for T
    where
     U: Into<T>,
    §
    type Error = Infallible
    The type returned in the event of a conversion error.
    source§
    fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
    Performs the conversion.
    source§
    impl<T, U> TryInto<U> for T
    where
-    U: TryFrom<T>,
    §
    type Error = <U as TryFrom<T>>::Error
    The type returned in the event of a conversion error.
    source§
    fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
    Performs the conversion.
    
\ No newline at end of file
+    U: TryFrom<T>,
    §
    type Error = <U as TryFrom<T>>::Error
    The type returned in the event of a conversion error.
    source§
    fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
    Performs the conversion.
    
\ No newline at end of file
diff --git a/winnow/combinator/struct.Recognize.html b/winnow/combinator/struct.Recognize.html
index 841236188..7272cb930 100644
--- a/winnow/combinator/struct.Recognize.html
+++ b/winnow/combinator/struct.Recognize.html
@@ -1,36 +1,36 @@
-Recognize in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::Recognize
    source · 
    pub struct Recognize<F, I, O, E>
    where
+Recognize in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::Recognize
    source · 
    pub struct Recognize<F, I, O, E>
    where
     F: Parser<I, O, E>,
     I: Stream,
    { /* private fields */ }
    Expand description
    Implementation of Parser::recognize
    
-
    Trait Implementations§
    source§
    impl<I, O, E, F> Parser<I, <I as Stream>::Slice, E> for Recognize<F, I, O, E>
    where
+
    Trait Implementations§
    source§
    impl<I, O, E, F> Parser<I, <I as Stream>::Slice, E> for Recognize<F, I, O, E>
    where
     F: Parser<I, O, E>,
-    I: Stream,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    I: Stream,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<<I as Stream>::Slice, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, E> Freeze for Recognize<F, I, O, E>
    where
     F: Freeze,
    §
    impl<F, I, O, E> RefUnwindSafe for Recognize<F, I, O, E>
    where
diff --git a/winnow/combinator/struct.Repeat.html b/winnow/combinator/struct.Repeat.html
index 36a815383..a63496425 100644
--- a/winnow/combinator/struct.Repeat.html
+++ b/winnow/combinator/struct.Repeat.html
@@ -1,4 +1,4 @@
-Repeat in winnow::combinator - Rust
    
+Repeat in winnow::combinator - Rust
    
     
    Struct winnow::combinator::Repeat
    source · 
    pub struct Repeat<P, I, O, C, E>
    where
     P: Parser<I, O, E>,
     I: Stream,
@@ -94,47 +94,47 @@ to prevent going into an infinite loop.
    
     P: Parser<I, O, E>,
     I: Stream,
     C: Accumulate<O>,
-    E: ParserError<I>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<C, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    E: ParserError<I>,
    source§
    fn parse_next(&mut self, i: &mut I) -> PResult<C, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<P, I, O, C, E> Freeze for Repeat<P, I, O, C, E>
    where
     P: Freeze,
    §
    impl<P, I, O, C, E> RefUnwindSafe for Repeat<P, I, O, C, E>
    where
diff --git a/winnow/combinator/struct.Span.html b/winnow/combinator/struct.Span.html
index 099eb77f1..aa96c2229 100644
--- a/winnow/combinator/struct.Span.html
+++ b/winnow/combinator/struct.Span.html
@@ -1,40 +1,40 @@
-Span in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::Span
    source · 
    pub struct Span<F, I, O, E>
    where
+Span in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::Span
    source · 
    pub struct Span<F, I, O, E>
    where
     F: Parser<I, O, E>,
     I: Stream + Location,
    { /* private fields */ }
    Expand description
    Implementation of Parser::span
    
-
    Trait Implementations§
    source§
    impl<I, O, E, F> Parser<I, Range<usize>, E> for Span<F, I, O, E>
    where
+
    Trait Implementations§
    source§
    impl<I, O, E, F> Parser<I, Range<usize>, E> for Span<F, I, O, E>
    where
     F: Parser<I, O, E>,
-    I: Stream + Location,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<Range<usize>, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    I: Stream + Location,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<Range<usize>, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn span(self) -> Span<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn span(self) -> Span<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream + Location,
    Produce the location of the consumed input as produced value. Read more
    source§
    fn with_span(self) -> WithSpan<Self, I, O, E>
    where
+    I: Stream + Location,
    Produce the location of the consumed input as produced value. Read more
    source§
    fn with_span(self) -> WithSpan<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream + Location,
    Produce the location of consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream + Location,
    Produce the location of consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, E> Freeze for Span<F, I, O, E>
    where
     F: Freeze,
    §
    impl<F, I, O, E> RefUnwindSafe for Span<F, I, O, E>
    where
diff --git a/winnow/combinator/struct.TryMap.html b/winnow/combinator/struct.TryMap.html
index 1fc58f058..65fa4deef 100644
--- a/winnow/combinator/struct.TryMap.html
+++ b/winnow/combinator/struct.TryMap.html
@@ -1,40 +1,40 @@
-TryMap in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::TryMap
    source · 
    pub struct TryMap<F, G, I, O, O2, E, E2>
    where
+TryMap in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::TryMap
    source · 
    pub struct TryMap<F, G, I, O, O2, E, E2>
    where
     F: Parser<I, O, E>,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
     E: FromExternalError<I, E2>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::try_map
    
-
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E, E2> Parser<I, O2, E> for TryMap<F, G, I, O, O2, E, E2>
    where
+
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E, E2> Parser<I, O2, E> for TryMap<F, G, I, O, O2, E, E2>
    where
     F: Parser<I, O, E>,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, G, I, O, O2, E, E2> Freeze for TryMap<F, G, I, O, O2, E, E2>
    where
     F: Freeze,
diff --git a/winnow/combinator/struct.Value.html b/winnow/combinator/struct.Value.html
index 67117387c..e875a0cfe 100644
--- a/winnow/combinator/struct.Value.html
+++ b/winnow/combinator/struct.Value.html
@@ -1,24 +1,24 @@
-Value in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::Value
    source · 
    pub struct Value<F, I, O, O2, E>
    where
+Value in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::Value
    source · 
    pub struct Value<F, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     O2: Clone,
    { /* private fields */ }
    Expand description
    Implementation of Parser::value
    
-
    Trait Implementations§
    source§
    impl<F, I, O, O2, E> Parser<I, O2, E> for Value<F, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, O2, E> Parser<I, O2, E> for Value<F, I, O, O2, E>
    where
     F: Parser<I, O, E>,
-    O2: Clone,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    O2: Clone,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, O2, E> Freeze for Value<F, I, O, O2, E>
    where
     F: Freeze,
diff --git a/winnow/combinator/struct.Verify.html b/winnow/combinator/struct.Verify.html
index 10ae9d933..40d4b1219 100644
--- a/winnow/combinator/struct.Verify.html
+++ b/winnow/combinator/struct.Verify.html
@@ -1,58 +1,58 @@
-Verify in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::Verify
    source · 
    pub struct Verify<F, G, I, O, O2, E>
    where
+Verify in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::Verify
    source · 
    pub struct Verify<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
     E: ParserError<I>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::verify
    
-
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O, E> for Verify<F, G, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O, E> for Verify<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    E: ParserError<I>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, G, I, O, O2: ?Sized, E> Freeze for Verify<F, G, I, O, O2, E>
    where
     F: Freeze,
diff --git a/winnow/combinator/struct.VerifyMap.html b/winnow/combinator/struct.VerifyMap.html
index 906a09537..ae4d8e987 100644
--- a/winnow/combinator/struct.VerifyMap.html
+++ b/winnow/combinator/struct.VerifyMap.html
@@ -1,54 +1,54 @@
-VerifyMap in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::VerifyMap
    source · 
    pub struct VerifyMap<F, G, I, O, O2, E>
    where
+VerifyMap in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::VerifyMap
    source · 
    pub struct VerifyMap<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
     E: ParserError<I>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::verify_map
    
-
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O2, E> for VerifyMap<F, G, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, G, I, O, O2, E> Parser<I, O2, E> for VerifyMap<F, G, I, O, O2, E>
    where
     F: Parser<I, O, E>,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    E: ParserError<I>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<O2, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> Option<O2>,
     I: Stream,
-    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply both Parser::verify and Parser::map. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where
     Self: Sized,
     I: Stream,
     O: ParseSlice<O2>,
-    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
+    E: ParserError<I>,
    Apply std::str::FromStr to the output of the parser Read more
    source§
    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(&O2) -> bool,
     I: Stream,
     O: Borrow<O2>,
     O2: ?Sized,
-    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    E: ParserError<I>,
    Returns the output of the child parser if it satisfies a verification function. Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, G, I, O, O2, E> Freeze for VerifyMap<F, G, I, O, O2, E>
    where
     F: Freeze,
diff --git a/winnow/combinator/struct.Void.html b/winnow/combinator/struct.Void.html
index ea8db1e2c..ab68c8882 100644
--- a/winnow/combinator/struct.Void.html
+++ b/winnow/combinator/struct.Void.html
@@ -1,22 +1,22 @@
-Void in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::Void
    source · 
    pub struct Void<F, I, O, E>
    where
+Void in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::Void
    source · 
    pub struct Void<F, I, O, E>
    where
     F: Parser<I, O, E>,
    { /* private fields */ }
    Expand description
    Implementation of Parser::void
    
-
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, (), E> for Void<F, I, O, E>
    where
-    F: Parser<I, O, E>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<(), E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, (), E> for Void<F, I, O, E>
    where
+    F: Parser<I, O, E>,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<(), E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, E> Freeze for Void<F, I, O, E>
    where
     F: Freeze,
    §
    impl<F, I, O, E> RefUnwindSafe for Void<F, I, O, E>
    where
diff --git a/winnow/combinator/struct.WithRecognized.html b/winnow/combinator/struct.WithRecognized.html
index c4567b4e2..6ab2ea85c 100644
--- a/winnow/combinator/struct.WithRecognized.html
+++ b/winnow/combinator/struct.WithRecognized.html
@@ -1,36 +1,36 @@
-WithRecognized in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::WithRecognized
    source · 
    pub struct WithRecognized<F, I, O, E>
    where
+WithRecognized in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::WithRecognized
    source · 
    pub struct WithRecognized<F, I, O, E>
    where
     F: Parser<I, O, E>,
     I: Stream,
    { /* private fields */ }
    Expand description
    Implementation of Parser::with_recognized
    
-
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, (O, <I as Stream>::Slice), E> for WithRecognized<F, I, O, E>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, (O, <I as Stream>::Slice), E> for WithRecognized<F, I, O, E>
    where
     F: Parser<I, O, E>,
-    I: Stream,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<(O, <I as Stream>::Slice), E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    I: Stream,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<(O, <I as Stream>::Slice), E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, E> Freeze for WithRecognized<F, I, O, E>
    where
     F: Freeze,
    §
    impl<F, I, O, E> RefUnwindSafe for WithRecognized<F, I, O, E>
    where
diff --git a/winnow/combinator/struct.WithSpan.html b/winnow/combinator/struct.WithSpan.html
index 032027a1e..cf185c82a 100644
--- a/winnow/combinator/struct.WithSpan.html
+++ b/winnow/combinator/struct.WithSpan.html
@@ -1,40 +1,40 @@
-WithSpan in winnow::combinator - Rust
    
-    
    Struct winnow::combinator::WithSpan
    source · 
    pub struct WithSpan<F, I, O, E>
    where
+WithSpan in winnow::combinator - Rust
    
+    
    Struct winnow::combinator::WithSpan
    source · 
    pub struct WithSpan<F, I, O, E>
    where
     F: Parser<I, O, E>,
     I: Stream + Location,
    { /* private fields */ }
    Expand description
    Implementation of Parser::with_span
    
-
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, (O, Range<usize>), E> for WithSpan<F, I, O, E>
    where
+
    Trait Implementations§
    source§
    impl<F, I, O, E> Parser<I, (O, Range<usize>), E> for WithSpan<F, I, O, E>
    where
     F: Parser<I, O, E>,
-    I: Stream + Location,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<(O, Range<usize>), E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
-    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
+    I: Stream + Location,
    source§
    fn parse_next(&mut self, input: &mut I) -> PResult<(O, Range<usize>), E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output Read more
    source§
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+    Self: Sized,
    Treat &mut Self as a parser Read more
    source§
    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
+    O2: Clone,
    Produce the provided value Read more
    source§
    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where
     Self: Sized,
-    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
-    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
+    O2: Default,
    Produce a type’s default value Read more
    source§
    fn void(self) -> Void<Self, I, O, E>
    where
+    Self: Sized,
    Discards the output of the Parser Read more
    source§
    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where
     Self: Sized,
-    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
+    O: Into<O2>,
    Convert the parser’s output to another type using std::convert::From Read more
    source§
    fn recognize(self) -> Recognize<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input as produced value. Read more
    source§
    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn span(self) -> Span<Self, I, O, E>
    where
+    I: Stream,
    Produce the consumed input with the output Read more
    source§
    fn span(self) -> Span<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream + Location,
    Produce the location of the consumed input as produced value. Read more
    source§
    fn with_span(self) -> WithSpan<Self, I, O, E>
    where
+    I: Stream + Location,
    Produce the location of the consumed input as produced value. Read more
    source§
    fn with_span(self) -> WithSpan<Self, I, O, E>
    where
     Self: Sized,
-    I: Stream + Location,
    Produce the location of consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
+    I: Stream + Location,
    Produce the location of consumed input with the output Read more
    source§
    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where
     G: FnMut(O) -> O2,
-    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
+    Self: Sized,
    Maps a function over the output of a parser Read more
    source§
    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where
     Self: Sized,
     G: FnMut(O) -> Result<O2, E2>,
     I: Stream,
-    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
+    E: FromExternalError<I, E2>,
    Applies a function returning a Result over the output of a parser. Read more
    source§
    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where
     Self: Sized,
     G: FnMut(O) -> H,
-    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
+    H: Parser<I, O2, E>,
    Creates a parser from the output of this one Read more
    source§
    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where
     Self: Sized,
     I: Stream,
     E: AddContext<I, C>,
-    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
-    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
+    C: Clone + Debug,
    If parsing fails, add context to the error Read more
    source§
    fn complete_err(self) -> CompleteErr<Self>
    where
+    Self: Sized,
    Transforms Incomplete into Backtrack Read more
    source§
    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where
     Self: Sized,
     E: Into<E2>,
    Convert the parser’s error to another type using std::convert::From
    Auto Trait Implementations§
    §
    impl<F, I, O, E> Freeze for WithSpan<F, I, O, E>
    where
     F: Freeze,
    §
    impl<F, I, O, E> RefUnwindSafe for WithSpan<F, I, O, E>
    where
diff --git a/winnow/combinator/trait.Alt.html b/winnow/combinator/trait.Alt.html
index 7a693b9d6..8968370e9 100644
--- a/winnow/combinator/trait.Alt.html
+++ b/winnow/combinator/trait.Alt.html
@@ -1,8 +1,8 @@
-Alt in winnow::combinator - Rust
    
+Alt in winnow::combinator - Rust
    
     
    Trait winnow::combinator::Alt
    source · 
    pub trait Alt<I, O, E> {
     // Required method
     fn choice(&mut self, input: &mut I) -> PResult<O, E>;
-}
    Expand description
    Helper trait for the alt() combinator.
    
+}
    Expand description
    Helper trait for the alt() combinator.
    
 
    This trait is implemented for tuples of up to 21 elements
    
 
    Required Methods§
    source
    fn choice(&mut self, input: &mut I) -> PResult<O, E>
    Tests each parser in the tuple and returns the result of the first one that succeeds
    
-
    Implementations on Foreign Types§
    source§
    impl<I: Stream, O, E: ParserError<I>, A: Parser<I, O, E>> Alt<I, O, E> for (A,)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<O, E>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>, Alt20: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19, Alt20)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>, Alt20: Parser<I, Output, Error>, Alt21: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19, Alt20, Alt21)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>, Alt20: Parser<I, Output, Error>, Alt21: Parser<I, Output, Error>, Alt22: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19, Alt20, Alt21, Alt22)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<const N: usize, I: Stream, O, E: ParserError<I>, P: Parser<I, O, E>> Alt<I, O, E> for [P; N]
    source§
    fn choice(&mut self, input: &mut I) -> PResult<O, E>
    Implementors§
    
\ No newline at end of file
+
    Implementations on Foreign Types§
    source§
    impl<I: Stream, O, E: ParserError<I>, A: Parser<I, O, E>> Alt<I, O, E> for (A,)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<O, E>
    source§
    impl<I: Stream, O, E: ParserError<I>, P: Parser<I, O, E>> Alt<I, O, E> for &mut [P]
    source§
    fn choice(&mut self, input: &mut I) -> PResult<O, E>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>, Alt20: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19, Alt20)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>, Alt20: Parser<I, Output, Error>, Alt21: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19, Alt20, Alt21)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<I: Stream, Output, Error: ParserError<I>, Alt2: Parser<I, Output, Error>, Alt3: Parser<I, Output, Error>, Alt4: Parser<I, Output, Error>, Alt5: Parser<I, Output, Error>, Alt6: Parser<I, Output, Error>, Alt7: Parser<I, Output, Error>, Alt8: Parser<I, Output, Error>, Alt9: Parser<I, Output, Error>, Alt10: Parser<I, Output, Error>, Alt11: Parser<I, Output, Error>, Alt12: Parser<I, Output, Error>, Alt13: Parser<I, Output, Error>, Alt14: Parser<I, Output, Error>, Alt15: Parser<I, Output, Error>, Alt16: Parser<I, Output, Error>, Alt17: Parser<I, Output, Error>, Alt18: Parser<I, Output, Error>, Alt19: Parser<I, Output, Error>, Alt20: Parser<I, Output, Error>, Alt21: Parser<I, Output, Error>, Alt22: Parser<I, Output, Error>> Alt<I, Output, Error> for (Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11, Alt12, Alt13, Alt14, Alt15, Alt16, Alt17, Alt18, Alt19, Alt20, Alt21, Alt22)
    source§
    fn choice(&mut self, input: &mut I) -> PResult<Output, Error>
    source§
    impl<const N: usize, I: Stream, O, E: ParserError<I>, P: Parser<I, O, E>> Alt<I, O, E> for [P; N]
    source§
    fn choice(&mut self, input: &mut I) -> PResult<O, E>
    Implementors§
    
\ No newline at end of file
diff --git a/winnow/combinator/trait.Permutation.html b/winnow/combinator/trait.Permutation.html
index e16c42ae8..a9cf54485 100644
--- a/winnow/combinator/trait.Permutation.html
+++ b/winnow/combinator/trait.Permutation.html
@@ -1,56 +1,56 @@
-Permutation in winnow::combinator - Rust
    
+Permutation in winnow::combinator - Rust
    
     
    Trait winnow::combinator::Permutation
    source · 
    pub trait Permutation<I, O, E> {
     // Required method
     fn permutation(&mut self, input: &mut I) -> PResult<O, E>;
-}
    Expand description
    Helper trait for the permutation() combinator.
    
+}
    Expand description
    Helper trait for the permutation() combinator.
    
 
    This trait is implemented for tuples of up to 21 elements
    
 
    Required Methods§
    source
    fn permutation(&mut self, input: &mut I) -> PResult<O, E>
    Tries to apply all parsers in the tuple in various orders until all of them succeed
    
-
    Implementations on Foreign Types§
    source§
    impl<I: Stream, O1, O2, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>> Permutation<I, (O1, O2), Error> for (P1, P2)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2), Error>
    source§
    impl<I: Stream, O1, O2, O3, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>> Permutation<I, (O1, O2, O3), Error> for (P1, P2, P3)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2, O3), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>> Permutation<I, (O1, O2, O3, O4), Error> for (P1, P2, P3, P4)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2, O3, O4), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>> Permutation<I, (O1, O2, O3, O4, O5), Error> for (P1, P2, P3, P4, P5)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2, O3, O4, O5), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6), Error> for (P1, P2, P3, P4, P5, P6)
    source§
    fn permutation(
+
    Implementations on Foreign Types§
    source§
    impl<I: Stream, O1, O2, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>> Permutation<I, (O1, O2), Error> for (P1, P2)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2), Error>
    source§
    impl<I: Stream, O1, O2, O3, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>> Permutation<I, (O1, O2, O3), Error> for (P1, P2, P3)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2, O3), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>> Permutation<I, (O1, O2, O3, O4), Error> for (P1, P2, P3, P4)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2, O3, O4), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>> Permutation<I, (O1, O2, O3, O4, O5), Error> for (P1, P2, P3, P4, P5)
    source§
    fn permutation(&mut self, input: &mut I) -> PResult<(O1, O2, O3, O4, O5), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6), Error> for (P1, P2, P3, P4, P5, P6)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7), Error> for (P1, P2, P3, P4, P5, P6, P7)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7), Error> for (P1, P2, P3, P4, P5, P6, P7)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8), Error> for (P1, P2, P3, P4, P5, P6, P7, P8)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8), Error> for (P1, P2, P3, P4, P5, P6, P7, P8)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>, P19: Parser<I, O19, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>, P19: Parser<I, O19, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>, P19: Parser<I, O19, Error>, P20: Parser<I, O20, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>, P19: Parser<I, O19, Error>, P20: Parser<I, O20, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20)
    source§
    fn permutation(
     &mut self,
     input: &mut I
-) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>, P19: Parser<I, O19, Error>, P20: Parser<I, O20, Error>, P21: Parser<I, O21, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20, P21)
    source§
    fn permutation(
+) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), Error>
    source§
    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21, Error: ParserError<I>, P1: Parser<I, O1, Error>, P2: Parser<I, O2, Error>, P3: Parser<I, O3, Error>, P4: Parser<I, O4, Error>, P5: Parser<I, O5, Error>, P6: Parser<I, O6, Error>, P7: Parser<I, O7, Error>, P8: Parser<I, O8, Error>, P9: Parser<I, O9, Error>, P10: Parser<I, O10, Error>, P11: Parser<I, O11, Error>, P12: Parser<I, O12, Error>, P13: Parser<I, O13, Error>, P14: Parser<I, O14, Error>, P15: Parser<I, O15, Error>, P16: Parser<I, O16, Error>, P17: Parser<I, O17, Error>, P18: Parser<I, O18, Error>, P19: Parser<I, O19, Error>, P20: Parser<I, O20, Error>, P21: Parser<I, O21, Error>> Permutation<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21), Error> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20, P21)
    source§
    fn permutation(
     &mut self,
     input: &mut I
 ) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21), Error>
    Implementors§
    
\ No newline at end of file
diff --git a/winnow/error/enum.ErrMode.html b/winnow/error/enum.ErrMode.html
index 2ee49a740..5fae4c2a9 100644
--- a/winnow/error/enum.ErrMode.html
+++ b/winnow/error/enum.ErrMode.html
@@ -1,4 +1,4 @@
-ErrMode in winnow::error - Rust
    
+ErrMode in winnow::error - Rust
    
     
    Enum winnow::error::ErrMode
    source · 
    pub enum ErrMode<E> {
     Incomplete(Needed),
     Backtrack(E),
@@ -35,8 +35,8 @@ and you want any further errors parsing the case to be reported to the user.
    
     input: &I,
     token_start: &<I as Stream>::Checkpoint,
     context: C
-) -> Self
    Append to an existing error custom data Read more
    source§
    impl<E: Clone> Clone for ErrMode<E>
    source§
    fn clone(&self) -> ErrMode<E>
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl<E: Debug> Debug for ErrMode<E>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<E> Display for ErrMode<E>
    where
-    E: Debug,
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I, EXT, E> FromExternalError<I, EXT> for ErrMode<E>
    where
+) -> Self
    Append to an existing error custom data Read more
    source§
    impl<E: Clone> Clone for ErrMode<E>
    source§
    fn clone(&self) -> ErrMode<E>
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl<E: Debug> Debug for ErrMode<E>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<E> Display for ErrMode<E>
    where
+    E: Debug,
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I, EXT, E> FromExternalError<I, EXT> for ErrMode<E>
    where
     E: FromExternalError<I, EXT>,
    source§
    fn from_external_error(input: &I, kind: ErrorKind, e: EXT) -> Self
    Like ParserError::from_error_kind but also include an external error.
    source§
    impl<I: Stream, E: ParserError<I>> ParserError<I> for ErrMode<E>
    source§
    fn from_error_kind(input: &I, kind: ErrorKind) -> Self
    Creates an error from the input position and an ErrorKind
    source§
    fn assert(input: &I, message: &'static str) -> Self
    where
     I: Debug,
    Process a parser assertion
    source§
    fn append(
     self,
diff --git a/winnow/error/enum.ErrorKind.html b/winnow/error/enum.ErrorKind.html
index 936ff21fa..ae2cc717d 100644
--- a/winnow/error/enum.ErrorKind.html
+++ b/winnow/error/enum.ErrorKind.html
@@ -1,5 +1,5 @@
-ErrorKind in winnow::error - Rust
    
-    
    Enum winnow::error::ErrorKind
    source · 
    pub enum ErrorKind {
+ErrorKind in winnow::error - Rust
    
+    
    Enum winnow::error::ErrorKind
    source · 
    pub enum ErrorKind {
     Assert,
     Token,
     Tag,
@@ -12,25 +12,25 @@
     Verify,
     Fail,
 }
    Expand description
    Provide some minor debug context for errors
    
-
    Variants§
    §
    Assert
    §
    Token
    §
    Tag
    §
    Alt
    §
    Many
    §
    Eof
    §
    Slice
    §
    Complete
    §
    Not
    §
    Verify
    §
    Fail
    Implementations§
    source§
    impl ErrorKind
    source
    pub fn description(&self) -> &str
    Converts an ErrorKind to a text description
    
-
    Trait Implementations§
    source§
    impl<I: Stream, C> AddContext<I, C> for ErrorKind
    source§
    fn add_context(
+
    Variants§
    §
    Assert
    §
    Token
    §
    Tag
    §
    Alt
    §
    Many
    §
    Eof
    §
    Slice
    §
    Complete
    §
    Not
    §
    Verify
    §
    Fail
    Implementations§
    source§
    impl ErrorKind
    source
    pub fn description(&self) -> &str
    Converts an ErrorKind to a text description
    
+
    Trait Implementations§
    source§
    impl<I: Stream, C> AddContext<I, C> for ErrorKind
    source§
    fn add_context(
     self,
     _input: &I,
     _token_start: &<I as Stream>::Checkpoint,
     _context: C
-) -> Self
    Append to an existing error custom data Read more
    source§
    impl Clone for ErrorKind
    source§
    fn clone(&self) -> ErrorKind
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl Debug for ErrorKind
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Display for ErrorKind
    The Display implementation allows the std::error::Error implementation
    
-
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Error for ErrorKind
    1.30.0 · source§
    fn source(&self) -> Option<&(dyn Error + 'static)>
    The lower-level source of this error, if any. Read more
    1.0.0 · source§
    fn description(&self) -> &str
    👎Deprecated since 1.42.0: use the Display impl or to_string()
     Read more
    1.0.0 · source§
    fn cause(&self) -> Option<&dyn Error>
    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§
    fn provide<'a>(&'a self, request: &mut Request<'a>)
    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more
    source§
    impl<I, E> FromExternalError<I, E> for ErrorKind
    source§
    fn from_external_error(_input: &I, kind: ErrorKind, _e: E) -> Self
    Create a new error from an input position and an external error
    
-
    source§
    impl Hash for ErrorKind
    source§
    fn hash<__H: Hasher>(&self, state: &mut __H)
    Feeds this value into the given Hasher. Read more
    1.3.0 · source§
    fn hash_slice<H>(data: &[Self], state: &mut H)
    where
+) -> Self
    Append to an existing error custom data Read more
    source§
    impl Clone for ErrorKind
    source§
    fn clone(&self) -> ErrorKind
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl Debug for ErrorKind
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Display for ErrorKind
    The Display implementation allows the std::error::Error implementation
    
+
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Error for ErrorKind
    1.30.0 · source§
    fn source(&self) -> Option<&(dyn Error + 'static)>
    The lower-level source of this error, if any. Read more
    1.0.0 · source§
    fn description(&self) -> &str
    👎Deprecated since 1.42.0: use the Display impl or to_string()
     Read more
    1.0.0 · source§
    fn cause(&self) -> Option<&dyn Error>
    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§
    fn provide<'a>(&'a self, request: &mut Request<'a>)
    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more
    source§
    impl<I, E> FromExternalError<I, E> for ErrorKind
    source§
    fn from_external_error(_input: &I, kind: ErrorKind, _e: E) -> Self
    Create a new error from an input position and an external error
    
+
    source§
    impl Hash for ErrorKind
    source§
    fn hash<__H: Hasher>(&self, state: &mut __H)
    Feeds this value into the given Hasher. Read more
    1.3.0 · source§
    fn hash_slice<H>(data: &[Self], state: &mut H)
    where
     H: Hasher,
-    Self: Sized,
    Feeds a slice of this type into the given Hasher. Read more
    source§
    impl<I: Stream> ParserError<I> for ErrorKind
    source§
    fn from_error_kind(_input: &I, kind: ErrorKind) -> Self
    Creates an error from the input position and an ErrorKind
    source§
    fn append(
+    Self: Sized,
    Feeds a slice of this type into the given Hasher. Read more
    source§
    impl<I: Stream> ParserError<I> for ErrorKind
    source§
    fn from_error_kind(_input: &I, kind: ErrorKind) -> Self
    Creates an error from the input position and an ErrorKind
    source§
    fn append(
     self,
     _input: &I,
     _token_start: &<I as Stream>::Checkpoint,
     _kind: ErrorKind
 ) -> Self
    Like ParserError::from_error_kind but merges it with the existing error. Read more
    source§
    fn assert(input: &I, _message: &'static str) -> Self
    where
-    I: Debug,
    Process a parser assertion
    source§
    fn or(self, other: Self) -> Self
    Combines errors from two different parse branches. Read more
    source§
    impl PartialEq for ErrorKind
    source§
    fn eq(&self, other: &ErrorKind) -> bool
    This method tests for self and other values to be equal, and is used
+    I: Debug,
    Process a parser assertion
    source§
    fn or(self, other: Self) -> Self
    Combines errors from two different parse branches. Read more
    source§
    impl PartialEq for ErrorKind
    source§
    fn eq(&self, other: &ErrorKind) -> bool
    This method tests for self and other values to be equal, and is used
 by ==.
    1.0.0 · source§
    fn ne(&self, other: &Rhs) -> bool
    This method tests for !=. The default implementation is almost always
-sufficient, and should not be overridden without very good reason.
    source§
    impl Copy for ErrorKind
    source§
    impl Eq for ErrorKind
    source§
    impl StructuralPartialEq for ErrorKind
    Auto Trait Implementations§
    Blanket Implementations§
    source§
    impl<T> Any for T
    where
+sufficient, and should not be overridden without very good reason.
    source§
    impl Copy for ErrorKind
    source§
    impl Eq for ErrorKind
    source§
    impl StructuralPartialEq for ErrorKind
    Auto Trait Implementations§
    Blanket Implementations§
    source§
    impl<T> Any for T
    where
     T: 'static + ?Sized,
    source§
    fn type_id(&self) -> TypeId
    Gets the TypeId of self. Read more
    source§
    impl<T> Borrow<T> for T
    where
     T: ?Sized,
    source§
    fn borrow(&self) -> &T
    Immutably borrows from an owned value. Read more
    source§
    impl<T> BorrowMut<T> for T
    where
     T: ?Sized,
    source§
    fn borrow_mut(&mut self) -> &mut T
    Mutably borrows from an owned value. Read more
    source§
    impl<T> From<T> for T
    source§
    fn from(t: T) -> T
    Returns the argument unchanged.
    
diff --git a/winnow/error/enum.Needed.html b/winnow/error/enum.Needed.html
index fcbe188f7..642199db3 100644
--- a/winnow/error/enum.Needed.html
+++ b/winnow/error/enum.Needed.html
@@ -1,4 +1,4 @@
-Needed in winnow::error - Rust
    
+Needed in winnow::error - Rust
    
     
    Enum winnow::error::Needed
    source · 
    pub enum Needed {
     Unknown,
     Size(NonZeroUsize),
diff --git a/winnow/error/enum.StrContext.html b/winnow/error/enum.StrContext.html
index de2cbd05a..5fcf9d643 100644
--- a/winnow/error/enum.StrContext.html
+++ b/winnow/error/enum.StrContext.html
@@ -1,13 +1,13 @@
-StrContext in winnow::error - Rust
    
-    
    Enum winnow::error::StrContext
    source · 
    #[non_exhaustive]
    pub enum StrContext {
+StrContext in winnow::error - Rust
    
+    
    Enum winnow::error::StrContext
    source · 
    #[non_exhaustive]
    pub enum StrContext {
     Label(&'static str),
     Expected(StrContextValue),
 }
    Expand description
    Additional parse context for ContextError added via Parser::context
    
 
    Variants (Non-exhaustive)§
    This enum is marked as non-exhaustive
    Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
    §
    Label(&'static str)
    Description of what is currently being parsed
    
 
    §
    Expected(StrContextValue)
    Grammar item that was expected
    
-
    Trait Implementations§
    source§
    impl Clone for StrContext
    source§
    fn clone(&self) -> StrContext
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl Debug for StrContext
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Display for StrContext
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl PartialEq for StrContext
    source§
    fn eq(&self, other: &StrContext) -> bool
    This method tests for self and other values to be equal, and is used
+
    Trait Implementations§
    source§
    impl Clone for StrContext
    source§
    fn clone(&self) -> StrContext
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl Debug for StrContext
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Display for StrContext
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl PartialEq for StrContext
    source§
    fn eq(&self, other: &StrContext) -> bool
    This method tests for self and other values to be equal, and is used
 by ==.
    1.0.0 · source§
    fn ne(&self, other: &Rhs) -> bool
    This method tests for !=. The default implementation is almost always
-sufficient, and should not be overridden without very good reason.
    source§
    impl Eq for StrContext
    source§
    impl StructuralPartialEq for StrContext
    Auto Trait Implementations§
    Blanket Implementations§
    source§
    impl<T> Any for T
    where
+sufficient, and should not be overridden without very good reason.
    source§
    impl Eq for StrContext
    source§
    impl StructuralPartialEq for StrContext
    Auto Trait Implementations§
    Blanket Implementations§
    source§
    impl<T> Any for T
    where
     T: 'static + ?Sized,
    source§
    fn type_id(&self) -> TypeId
    Gets the TypeId of self. Read more
    source§
    impl<T> Borrow<T> for T
    where
     T: ?Sized,
    source§
    fn borrow(&self) -> &T
    Immutably borrows from an owned value. Read more
    source§
    impl<T> BorrowMut<T> for T
    where
     T: ?Sized,
    source§
    fn borrow_mut(&mut self) -> &mut T
    Mutably borrows from an owned value. Read more
    source§
    impl<T> From<T> for T
    source§
    fn from(t: T) -> T
    Returns the argument unchanged.
    
diff --git a/winnow/error/enum.StrContextValue.html b/winnow/error/enum.StrContextValue.html
index b8debc47e..cf8b352ff 100644
--- a/winnow/error/enum.StrContextValue.html
+++ b/winnow/error/enum.StrContextValue.html
@@ -1,5 +1,5 @@
-StrContextValue in winnow::error - Rust
    
-    
    Enum winnow::error::StrContextValue
    source · 
    #[non_exhaustive]
    pub enum StrContextValue {
+StrContextValue in winnow::error - Rust
    
+    
    Enum winnow::error::StrContextValue
    source · 
    #[non_exhaustive]
    pub enum StrContextValue {
     CharLiteral(char),
     StringLiteral(&'static str),
     Description(&'static str),
@@ -7,9 +7,9 @@
 
    Variants (Non-exhaustive)§
    This enum is marked as non-exhaustive
    Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
    §
    CharLiteral(char)
    A char token
    
 
    §
    StringLiteral(&'static str)
    A &str token
    
 
    §
    Description(&'static str)
    A description of what was being parsed
    
-
    Trait Implementations§
    source§
    impl Clone for StrContextValue
    source§
    fn clone(&self) -> StrContextValue
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl Debug for StrContextValue
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Display for StrContextValue
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl From<&'static str> for StrContextValue
    source§
    fn from(inner: &'static str) -> Self
    Converts to this type from the input type.
    source§
    impl From<char> for StrContextValue
    source§
    fn from(inner: char) -> Self
    Converts to this type from the input type.
    source§
    impl PartialEq for StrContextValue
    source§
    fn eq(&self, other: &StrContextValue) -> bool
    This method tests for self and other values to be equal, and is used
+
    Trait Implementations§
    source§
    impl Clone for StrContextValue
    source§
    fn clone(&self) -> StrContextValue
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl Debug for StrContextValue
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl Display for StrContextValue
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl From<&'static str> for StrContextValue
    source§
    fn from(inner: &'static str) -> Self
    Converts to this type from the input type.
    source§
    impl From<char> for StrContextValue
    source§
    fn from(inner: char) -> Self
    Converts to this type from the input type.
    source§
    impl PartialEq for StrContextValue
    source§
    fn eq(&self, other: &StrContextValue) -> bool
    This method tests for self and other values to be equal, and is used
 by ==.
    1.0.0 · source§
    fn ne(&self, other: &Rhs) -> bool
    This method tests for !=. The default implementation is almost always
-sufficient, and should not be overridden without very good reason.
    source§
    impl Eq for StrContextValue
    source§
    impl StructuralPartialEq for StrContextValue
    Auto Trait Implementations§
    Blanket Implementations§
    source§
    impl<T> Any for T
    where
+sufficient, and should not be overridden without very good reason.
    source§
    impl Eq for StrContextValue
    source§
    impl StructuralPartialEq for StrContextValue
    Auto Trait Implementations§
    Blanket Implementations§
    source§
    impl<T> Any for T
    where
     T: 'static + ?Sized,
    source§
    fn type_id(&self) -> TypeId
    Gets the TypeId of self. Read more
    source§
    impl<T> Borrow<T> for T
    where
     T: ?Sized,
    source§
    fn borrow(&self) -> &T
    Immutably borrows from an owned value. Read more
    source§
    impl<T> BorrowMut<T> for T
    where
     T: ?Sized,
    source§
    fn borrow_mut(&mut self) -> &mut T
    Mutably borrows from an owned value. Read more
    source§
    impl<T> From<T> for T
    source§
    fn from(t: T) -> T
    Returns the argument unchanged.
    
diff --git a/winnow/error/enum.TreeError.html b/winnow/error/enum.TreeError.html
index 76fd5887e..2582b64da 100644
--- a/winnow/error/enum.TreeError.html
+++ b/winnow/error/enum.TreeError.html
@@ -1,5 +1,5 @@
-TreeError in winnow::error - Rust
    
-    
    Enum winnow::error::TreeError
    source · 
    pub enum TreeError<I, C = StrContext> {
+TreeError in winnow::error - Rust
    
+    
    Enum winnow::error::TreeError
    source · 
    pub enum TreeError<I, C = StrContext> {
     Base(TreeErrorBase<I>),
     Stack {
         base: Box<Self>,
@@ -12,28 +12,28 @@
 
    §stack: Vec<TreeErrorFrame<I, C>>
    Traces added to the error while walking back up the stack
    
 
    Traces added to the error while walking back up the stack
    
 
    §
    Alt(Vec<Self>)
    All failed branches of an alt
    
-
    Implementations§
    source§
    impl<'i, I: ToOwned, C> TreeError<&'i I, C>
    where
+
    Implementations§
    source§
    impl<'i, I: ToOwned, C> TreeError<&'i I, C>
    where
     &'i I: Stream + Clone,
-    <I as ToOwned>::Owned: Clone,
    source
    pub fn into_owned(self) -> TreeError<<I as ToOwned>::Owned, C>
    Obtaining ownership
    
-
    source§
    impl<I, C> TreeError<I, C>
    where
-    I: Stream + Clone,
    source
    pub fn map_input<I2: Clone, O: Clone + Fn(I) -> I2>(
+    <I as ToOwned>::Owned: Clone,

    source

    pub fn into_owned(self) -> TreeError<<I as ToOwned>::Owned, C>

    Obtaining ownership

    +
    source§

    impl<I, C> TreeError<I, C>
    where + I: Stream + Clone,

    source

    pub fn map_input<I2: Clone, O: Clone + Fn(I) -> I2>( self, op: O ) -> TreeError<I2, C>

    Translate the input type

    -

    Trait Implementations§

    source§

    impl<I, C> AddContext<I, C> for TreeError<I, C>
    where - I: Stream + Clone,

    source§

    fn add_context( +

    Trait Implementations§

    source§

    impl<I, C> AddContext<I, C> for TreeError<I, C>
    where + I: Stream + Clone,

    source§

    fn add_context( self, input: &I, token_start: &<I as Stream>::Checkpoint, context: C -) -> Self

    Append to an existing error custom data Read more
    source§

    impl<I: Debug, C: Debug> Debug for TreeError<I, C>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I: Stream + Clone + Display, C: Display> Display for TreeError<I, C>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I: Stream + Clone + Debug + Display + Sync + Send + 'static, C: Display + Debug> Error for TreeError<I, C>

    1.30.0 · source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    1.0.0 · source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    Read more
    1.0.0 · source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more
    source§

    impl<I, C, E: Error + Send + Sync + 'static> FromExternalError<I, E> for TreeError<I, C>
    where - I: Stream + Clone,

    source§

    fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self

    Like ParserError::from_error_kind but also include an external error.
    source§

    impl<I, C> ParserError<I> for TreeError<I, C>
    where - I: Stream + Clone,

    source§

    fn from_error_kind(input: &I, kind: ErrorKind) -> Self

    Creates an error from the input position and an ErrorKind
    source§

    fn append( +) -> Self

    Append to an existing error custom data Read more
    source§

    impl<I: Debug, C: Debug> Debug for TreeError<I, C>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I: Stream + Clone + Display, C: Display> Display for TreeError<I, C>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I: Stream + Clone + Debug + Display + Sync + Send + 'static, C: Display + Debug> Error for TreeError<I, C>

    1.30.0 · source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    1.0.0 · source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    Read more
    1.0.0 · source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more
    source§

    impl<I, C, E: Error + Send + Sync + 'static> FromExternalError<I, E> for TreeError<I, C>
    where + I: Stream + Clone,

    source§

    fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self

    Like ParserError::from_error_kind but also include an external error.
    source§

    impl<I, C> ParserError<I> for TreeError<I, C>
    where + I: Stream + Clone,

    source§

    fn from_error_kind(input: &I, kind: ErrorKind) -> Self

    Creates an error from the input position and an ErrorKind
    source§

    fn append( self, input: &I, token_start: &<I as Stream>::Checkpoint, kind: ErrorKind -) -> Self

    Like ParserError::from_error_kind but merges it with the existing error. Read more
    source§

    fn or(self, other: Self) -> Self

    Combines errors from two different parse branches. Read more
    source§

    fn assert(input: &I, _message: &'static str) -> Self
    where +) -> Self

    Like ParserError::from_error_kind but merges it with the existing error. Read more
    source§

    fn or(self, other: Self) -> Self

    Combines errors from two different parse branches. Read more
    source§

    fn assert(input: &I, _message: &'static str) -> Self
    where I: Debug,

    Process a parser assertion

    Auto Trait Implementations§

    §

    impl<I, C> Freeze for TreeError<I, C>
    where I: Freeze,

    §

    impl<I, C = StrContext> !RefUnwindSafe for TreeError<I, C>

    §

    impl<I, C> Send for TreeError<I, C>
    where C: Send, diff --git a/winnow/error/enum.TreeErrorFrame.html b/winnow/error/enum.TreeErrorFrame.html index 636bee608..bf6da43d3 100644 --- a/winnow/error/enum.TreeErrorFrame.html +++ b/winnow/error/enum.TreeErrorFrame.html @@ -1,11 +1,11 @@ -TreeErrorFrame in winnow::error - Rust
    -

    Enum winnow::error::TreeErrorFrame

    source · 
    pub enum TreeErrorFrame<I, C = StrContext> {
+TreeErrorFrame in winnow::error - Rust
    
+    
    Enum winnow::error::TreeErrorFrame
    source · 
    pub enum TreeErrorFrame<I, C = StrContext> {
     Kind(TreeErrorBase<I>),
     Context(TreeErrorContext<I, C>),
 }
    Expand description
    See TreeError::Stack
    
 
    Variants§
    §
    Kind(TreeErrorBase<I>)
    See ParserError::append
    
 
    §
    Context(TreeErrorContext<I, C>)
    See AddContext::add_context
    
-
    Trait Implementations§
    source§
    impl<I: Debug, C: Debug> Debug for TreeErrorFrame<I, C>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    Auto Trait Implementations§
    §
    impl<I, C> Freeze for TreeErrorFrame<I, C>
    where
+
    Trait Implementations§
    source§
    impl<I: Debug, C: Debug> Debug for TreeErrorFrame<I, C>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    Auto Trait Implementations§
    §
    impl<I, C> Freeze for TreeErrorFrame<I, C>
    where
     C: Freeze,
     I: Freeze,
    §
    impl<I, C = StrContext> !RefUnwindSafe for TreeErrorFrame<I, C>
    §
    impl<I, C> Send for TreeErrorFrame<I, C>
    where
     C: Send,
diff --git a/winnow/error/index.html b/winnow/error/index.html
index fd51b1cc7..dd2793b7c 100644
--- a/winnow/error/index.html
+++ b/winnow/error/index.html
@@ -1,5 +1,5 @@
-winnow::error - Rust
    
-    
    Module winnow::error
    source · 
    Expand description
    §Error management
    
+winnow::error - Rust
    
+    
    Module winnow::error
    source · 
    Expand description
    §Error management
    
 
    Errors are designed with multiple needs in mind:
    
 
    source§
    fn or(self, other: Self) -> Self
    Combines errors from two different parse branches. Read more
    source§
    impl<I: PartialEq + Clone> PartialEq for InputError<I>
    source§
    fn eq(&self, other: &InputError<I>) -> bool
    This method tests for self and other values to be equal, and is used
 by ==.
    1.0.0 · source§
    fn ne(&self, other: &Rhs) -> bool
    This method tests for !=. The default implementation is almost always
-sufficient, and should not be overridden without very good reason.
    source§
    impl<I: Copy + Clone> Copy for InputError<I>
    source§
    impl<I: Eq + Clone> Eq for InputError<I>
    source§
    impl<I: Clone> StructuralPartialEq for InputError<I>
    Auto Trait Implementations§
    §
    impl<I> Freeze for InputError<I>
    where
+sufficient, and should not be overridden without very good reason.
    source§
    impl<I: Copy + Clone> Copy for InputError<I>
    source§
    impl<I: Eq + Clone> Eq for InputError<I>
    source§
    impl<I: Clone> StructuralPartialEq for InputError<I>
    Auto Trait Implementations§
    §
    impl<I> Freeze for InputError<I>
    where
     I: Freeze,
    §
    impl<I> RefUnwindSafe for InputError<I>
    where
     I: RefUnwindSafe,
    §
    impl<I> Send for InputError<I>
    where
     I: Send,
    §
    impl<I> Sync for InputError<I>
    where
diff --git a/winnow/error/struct.ParseError.html b/winnow/error/struct.ParseError.html
index 03ef58228..e673fda2f 100644
--- a/winnow/error/struct.ParseError.html
+++ b/winnow/error/struct.ParseError.html
@@ -1,16 +1,16 @@
-ParseError in winnow::error - Rust
    
-    
    Struct winnow::error::ParseError
    source · 
    pub struct ParseError<I, E> { /* private fields */ }
    Expand description
    See Parser::parse
    
-
    Implementations§
    source§
    impl<I, E> ParseError<I, E>
    source
    pub fn input(&self) -> &I
    The Stream at the initial location when parsing started
    
-
    source
    pub fn offset(&self) -> usize
    The location in ParseError::input where parsing failed
    
+ParseError in winnow::error - Rust
    
+    
    Struct winnow::error::ParseError
    source · 
    pub struct ParseError<I, E> { /* private fields */ }
    Expand description
    See Parser::parse
    
+
    Implementations§
    source§
    impl<I, E> ParseError<I, E>
    source
    pub fn input(&self) -> &I
    The Stream at the initial location when parsing started
    
+
    source
    pub fn offset(&self) -> usize
    The location in ParseError::input where parsing failed
    
 
    Note: This is an offset, not an index, and may point to the end of input
 (input.len()) on eof errors.
    
-
    source
    pub fn inner(&self) -> &E
    The original ParserError
    
-
    source
    pub fn into_inner(self) -> E
    The original ParserError
    
-
    Trait Implementations§
    source§
    impl<I: Clone, E: Clone> Clone for ParseError<I, E>
    source§
    fn clone(&self) -> ParseError<I, E>
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl<I: Debug, E: Debug> Debug for ParseError<I, E>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I, E> Display for ParseError<I, E>
    where
+
    source
    pub fn inner(&self) -> &E
    The original ParserError
    
+
    source
    pub fn into_inner(self) -> E
    The original ParserError
    
+
    Trait Implementations§
    source§
    impl<I: Clone, E: Clone> Clone for ParseError<I, E>
    source§
    fn clone(&self) -> ParseError<I, E>
    Returns a copy of the value. Read more
    1.0.0 · source§
    fn clone_from(&mut self, source: &Self)
    Performs copy-assignment from source. Read more
    source§
    impl<I: Debug, E: Debug> Debug for ParseError<I, E>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I, E> Display for ParseError<I, E>
    where
     I: AsBStr,
-    E: Display,
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I: PartialEq, E: PartialEq> PartialEq for ParseError<I, E>
    source§
    fn eq(&self, other: &ParseError<I, E>) -> bool
    This method tests for self and other values to be equal, and is used
+    E: Display,
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I: PartialEq, E: PartialEq> PartialEq for ParseError<I, E>
    source§
    fn eq(&self, other: &ParseError<I, E>) -> bool
    This method tests for self and other values to be equal, and is used
 by ==.
    1.0.0 · source§
    fn ne(&self, other: &Rhs) -> bool
    This method tests for !=. The default implementation is almost always
-sufficient, and should not be overridden without very good reason.
    source§
    impl<I: Eq, E: Eq> Eq for ParseError<I, E>
    source§
    impl<I, E> StructuralPartialEq for ParseError<I, E>
    Auto Trait Implementations§
    §
    impl<I, E> Freeze for ParseError<I, E>
    where
+sufficient, and should not be overridden without very good reason.
    source§
    impl<I: Eq, E: Eq> Eq for ParseError<I, E>
    source§
    impl<I, E> StructuralPartialEq for ParseError<I, E>
    Auto Trait Implementations§
    §
    impl<I, E> Freeze for ParseError<I, E>
    where
     E: Freeze,
     I: Freeze,
    §
    impl<I, E> RefUnwindSafe for ParseError<I, E>
    where
     E: RefUnwindSafe,
diff --git a/winnow/error/struct.TreeErrorBase.html b/winnow/error/struct.TreeErrorBase.html
index bc56a9bd3..3b8c6a91a 100644
--- a/winnow/error/struct.TreeErrorBase.html
+++ b/winnow/error/struct.TreeErrorBase.html
@@ -1,5 +1,5 @@
-TreeErrorBase in winnow::error - Rust
    
-    
    Struct winnow::error::TreeErrorBase
    source · 
    pub struct TreeErrorBase<I> {
+TreeErrorBase in winnow::error - Rust
    
+    
    Struct winnow::error::TreeErrorBase
    source · 
    pub struct TreeErrorBase<I> {
     pub input: I,
     pub kind: ErrorKind,
     pub cause: Option<Box<dyn Error + Send + Sync + 'static>>,
@@ -7,7 +7,7 @@
 
    Fields§
    §input: I
    Parsed input, at the location where the error occurred
    
 
    §kind: ErrorKind
    Debug context
    
 
    §cause: Option<Box<dyn Error + Send + Sync + 'static>>
    See FromExternalError::from_external_error
    
-
    Trait Implementations§
    source§
    impl<I: Debug> Debug for TreeErrorBase<I>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I: Stream + Clone + Display> Display for TreeErrorBase<I>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    Auto Trait Implementations§
    §
    impl<I> Freeze for TreeErrorBase<I>
    where
+
    Trait Implementations§
    source§
    impl<I: Debug> Debug for TreeErrorBase<I>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I: Stream + Clone + Display> Display for TreeErrorBase<I>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    Auto Trait Implementations§
    §
    impl<I> Freeze for TreeErrorBase<I>
    where
     I: Freeze,
    §
    impl<I> !RefUnwindSafe for TreeErrorBase<I>
    §
    impl<I> Send for TreeErrorBase<I>
    where
     I: Send,
    §
    impl<I> Sync for TreeErrorBase<I>
    where
     I: Sync,
    §
    impl<I> Unpin for TreeErrorBase<I>
    where
diff --git a/winnow/error/struct.TreeErrorContext.html b/winnow/error/struct.TreeErrorContext.html
index 154798643..f1f727361 100644
--- a/winnow/error/struct.TreeErrorContext.html
+++ b/winnow/error/struct.TreeErrorContext.html
@@ -1,11 +1,11 @@
-TreeErrorContext in winnow::error - Rust
    
-    
    Struct winnow::error::TreeErrorContext
    source · 
    pub struct TreeErrorContext<I, C = StrContext> {
+TreeErrorContext in winnow::error - Rust
    
+    
    Struct winnow::error::TreeErrorContext
    source · 
    pub struct TreeErrorContext<I, C = StrContext> {
     pub input: I,
     pub context: C,
 }
    Expand description
    See TreeErrorFrame::Context, AddContext::add_context
    
 
    Fields§
    §input: I
    Parsed input, at the location where the error occurred
    
 
    §context: C
    See AddContext::add_context
    
-
    Trait Implementations§
    source§
    impl<I: Debug, C: Debug> Debug for TreeErrorContext<I, C>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I: Stream + Clone + Display, C: Display> Display for TreeErrorContext<I, C>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    Auto Trait Implementations§
    §
    impl<I, C> Freeze for TreeErrorContext<I, C>
    where
+
    Trait Implementations§
    source§
    impl<I: Debug, C: Debug> Debug for TreeErrorContext<I, C>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    source§
    impl<I: Stream + Clone + Display, C: Display> Display for TreeErrorContext<I, C>
    source§
    fn fmt(&self, f: &mut Formatter<'_>) -> Result
    Formats the value using the given formatter. Read more
    Auto Trait Implementations§
    §
    impl<I, C> Freeze for TreeErrorContext<I, C>
    where
     C: Freeze,
     I: Freeze,
    §
    impl<I, C> RefUnwindSafe for TreeErrorContext<I, C>
    where
     C: RefUnwindSafe,
diff --git a/winnow/error/trait.AddContext.html b/winnow/error/trait.AddContext.html
index 4210af807..78c871071 100644
--- a/winnow/error/trait.AddContext.html
+++ b/winnow/error/trait.AddContext.html
@@ -1,4 +1,4 @@
-AddContext in winnow::error - Rust
    
+AddContext in winnow::error - Rust
    
     
    Trait winnow::error::AddContext
    source · 
    pub trait AddContext<I: Stream, C = &'static str>: Sized {
     // Provided method
     fn add_context(
@@ -17,5 +17,5 @@
 ) -> Self
    Append to an existing error custom data
    
 
    This is used mainly by Parser::context, to add user friendly information
 to errors when backtracking through a parse tree
    
-
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<I: Stream, C> AddContext<I, C> for ()
    Implementors§
    source§
    impl<C, I: Stream> AddContext<I, C> for ContextError<C>
    source§
    impl<I, C> AddContext<I, C> for TreeError<I, C>
    where
-    I: Stream + Clone,
    source§
    impl<I: Stream + Clone, C> AddContext<I, C> for InputError<I>
    source§
    impl<I: Stream, C> AddContext<I, C> for ErrorKind
    source§
    impl<I: Stream, C, E: AddContext<I, C>> AddContext<I, C> for ErrMode<E>
    
\ No newline at end of file
+
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<I: Stream, C> AddContext<I, C> for ()
    Implementors§
    source§
    impl<C, I: Stream> AddContext<I, C> for ContextError<C>
    source§
    impl<I, C> AddContext<I, C> for TreeError<I, C>
    where
+    I: Stream + Clone,
    source§
    impl<I: Stream + Clone, C> AddContext<I, C> for InputError<I>
    source§
    impl<I: Stream, C> AddContext<I, C> for ErrorKind
    source§
    impl<I: Stream, C, E: AddContext<I, C>> AddContext<I, C> for ErrMode<E>
    
\ No newline at end of file
diff --git a/winnow/error/trait.ErrorConvert.html b/winnow/error/trait.ErrorConvert.html
index a54c5b464..de79b8c1f 100644
--- a/winnow/error/trait.ErrorConvert.html
+++ b/winnow/error/trait.ErrorConvert.html
@@ -1,7 +1,7 @@
-ErrorConvert in winnow::error - Rust
    
-    
    Trait winnow::error::ErrorConvert
    source · 
    pub trait ErrorConvert<E> {
+ErrorConvert in winnow::error - Rust
    
+    
    Trait winnow::error::ErrorConvert
    source · 
    pub trait ErrorConvert<E> {
     // Required method
     fn convert(self) -> E;
 }
    Expand description
    Equivalent of From implementation to avoid orphan rules in bits parsers
    
-
    Required Methods§
    source
    fn convert(self) -> E
    Transform to another error type
    
-
    Implementations on Foreign Types§
    source§
    impl ErrorConvert<()> for ()
    source§
    fn convert(self)
    Implementors§
    
\ No newline at end of file
+
    Required Methods§
    source
    fn convert(self) -> E
    Transform to another error type
    
+
    Implementations on Foreign Types§
    source§
    impl ErrorConvert<()> for ()
    source§
    fn convert(self)
    Implementors§
    
\ No newline at end of file
diff --git a/winnow/error/trait.FromExternalError.html b/winnow/error/trait.FromExternalError.html
index 764768d0a..cc780df15 100644
--- a/winnow/error/trait.FromExternalError.html
+++ b/winnow/error/trait.FromExternalError.html
@@ -1,10 +1,10 @@
-FromExternalError in winnow::error - Rust
    
-    
    Trait winnow::error::FromExternalError
    source · 
    pub trait FromExternalError<I, E> {
+FromExternalError in winnow::error - Rust
    
+    
    Trait winnow::error::FromExternalError
    source · 
    pub trait FromExternalError<I, E> {
     // Required method
     fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self;
 }
    Expand description
    Create a new error with an external error, from std::str::FromStr
    
 
    This trait is required by the Parser::try_map combinator.
    
-
    Required Methods§
    source
    fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self
    Like ParserError::from_error_kind but also include an external error.
    
-
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<I, E> FromExternalError<I, E> for ()
    source§
    fn from_external_error(_input: &I, _kind: ErrorKind, _e: E) -> Self
    Implementors§
    source§
    impl<C, I, E: Error + Send + Sync + 'static> FromExternalError<I, E> for ContextError<C>
    source§
    impl<I, C, E: Error + Send + Sync + 'static> FromExternalError<I, E> for TreeError<I, C>
    where
-    I: Stream + Clone,
    source§
    impl<I, E> FromExternalError<I, E> for ErrorKind
    source§
    impl<I, EXT, E> FromExternalError<I, EXT> for ErrMode<E>
    where
-    E: FromExternalError<I, EXT>,
    source§
    impl<I: Clone, E> FromExternalError<I, E> for InputError<I>
    
\ No newline at end of file
+
    Required Methods§
    source
    fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self
    Like ParserError::from_error_kind but also include an external error.
    
+
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<I, E> FromExternalError<I, E> for ()
    source§
    fn from_external_error(_input: &I, _kind: ErrorKind, _e: E) -> Self
    Implementors§
    source§
    impl<C, I, E: Error + Send + Sync + 'static> FromExternalError<I, E> for ContextError<C>
    source§
    impl<I, C, E: Error + Send + Sync + 'static> FromExternalError<I, E> for TreeError<I, C>
    where
+    I: Stream + Clone,
    source§
    impl<I, E> FromExternalError<I, E> for ErrorKind
    source§
    impl<I, EXT, E> FromExternalError<I, EXT> for ErrMode<E>
    where
+    E: FromExternalError<I, EXT>,
    source§
    impl<I: Clone, E> FromExternalError<I, E> for InputError<I>
    
\ No newline at end of file
diff --git a/winnow/error/trait.ParserError.html b/winnow/error/trait.ParserError.html
index 28009a0c4..6e27aadaf 100644
--- a/winnow/error/trait.ParserError.html
+++ b/winnow/error/trait.ParserError.html
@@ -1,4 +1,4 @@
-ParserError in winnow::error - Rust
    
+ParserError in winnow::error - Rust
    
     
    Trait winnow::error::ParserError
    source · 
    pub trait ParserError<I: Stream>: Sized {
     // Required methods
     fn from_error_kind(input: &I, kind: ErrorKind) -> Self;
@@ -30,10 +30,10 @@ way.
    
 
    source
    fn or(self, other: Self) -> Self
    Combines errors from two different parse branches.
    
 
    For example, this would be used by alt to report the error from
 each case.
    
-

    Object Safety§

    This trait is not object safe.

    Implementations on Foreign Types§

    source§

    impl<I: Stream> ParserError<I> for ()

    source§

    fn from_error_kind(_: &I, _: ErrorKind) -> Self

    source§

    fn append( +

    Object Safety§

    This trait is not object safe.

    Implementations on Foreign Types§

    source§

    impl<I: Stream> ParserError<I> for ()

    source§

    fn from_error_kind(_: &I, _: ErrorKind) -> Self

    source§

    fn append( self, _input: &I, _token_start: &<I as Stream>::Checkpoint, _kind: ErrorKind -) -> Self

    Implementors§

    source§

    impl<I, C> ParserError<I> for TreeError<I, C>
    where - I: Stream + Clone,

    source§

    impl<I: Stream + Clone> ParserError<I> for InputError<I>

    source§

    impl<I: Stream> ParserError<I> for ErrorKind

    source§

    impl<I: Stream, C> ParserError<I> for ContextError<C>

    source§

    impl<I: Stream, E: ParserError<I>> ParserError<I> for ErrMode<E>

    \ No newline at end of file +) -> Self

    Implementors§

    source§

    impl<I, C> ParserError<I> for TreeError<I, C>
    where + I: Stream + Clone,

    source§

    impl<I: Stream + Clone> ParserError<I> for InputError<I>

    source§

    impl<I: Stream> ParserError<I> for ErrorKind

    source§

    impl<I: Stream, C> ParserError<I> for ContextError<C>

    source§

    impl<I: Stream, E: ParserError<I>> ParserError<I> for ErrMode<E>

    \ No newline at end of file diff --git a/winnow/error/type.IResult.html b/winnow/error/type.IResult.html index 8d698051a..7b489a943 100644 --- a/winnow/error/type.IResult.html +++ b/winnow/error/type.IResult.html @@ -1,4 +1,4 @@ -IResult in winnow::error - Rust
    +IResult in winnow::error - Rust

    Type Alias winnow::error::IResult

    source · 
    pub type IResult<I, O, E = InputError<I>> = PResult<(I, O), E>;
    Expand description

    For use with Parser::parse_peek which allows the input stream to be threaded through a parser.

    1.0.0 · source

    pub fn chunks(&self, chunk_size: usize) -> Chunks<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the +

    1.0.0 · source

    pub fn chunks(&self, chunk_size: usize) -> Chunks<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

    @@ -262,7 +262,7 @@ slice.

    assert_eq!(iter.next().unwrap(), &['r', 'e']); assert_eq!(iter.next().unwrap(), &['m']); assert!(iter.next().is_none());
    -
    1.31.0 · source

    pub fn chunks_exact(&self, chunk_size: usize) -> ChunksExact<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the +

    1.31.0 · source

    pub fn chunks_exact(&self, chunk_size: usize) -> ChunksExact<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved @@ -336,7 +336,7 @@ error before this method gets stabilized.

    let (remainder, chunks) = slice.as_rchunks(); assert_eq!(remainder, &['l']); assert_eq!(chunks, &[['o', 'r'], ['e', 'm']]);
    -
    source

    pub fn array_chunks<const N: usize>(&self) -> ArrayChunks<'_, T, N> ⓘ

    🔬This is a nightly-only experimental API. (array_chunks)

    Returns an iterator over N elements of the slice at a time, starting at the +

    source

    pub fn array_chunks<const N: usize>(&self) -> ArrayChunks<'_, T, N>

    🔬This is a nightly-only experimental API. (array_chunks)

    Returns an iterator over N elements of the slice at a time, starting at the beginning of the slice.

    The chunks are array references and do not overlap. If N does not divide the length of the slice, then the last up to N-1 elements will be omitted and can be @@ -353,7 +353,7 @@ error before this method gets stabilized.

    assert_eq!(iter.next().unwrap(), &['r', 'e']); assert!(iter.next().is_none()); assert_eq!(iter.remainder(), &['m']);
    -
    source

    pub fn array_windows<const N: usize>(&self) -> ArrayWindows<'_, T, N> ⓘ

    🔬This is a nightly-only experimental API. (array_windows)

    Returns an iterator over overlapping windows of N elements of a slice, +

    source

    pub fn array_windows<const N: usize>(&self) -> ArrayWindows<'_, T, N>

    🔬This is a nightly-only experimental API. (array_windows)

    Returns an iterator over overlapping windows of N elements of a slice, starting at the beginning of the slice.

    This is the const generic equivalent of windows.

    If N is greater than the size of the slice, it will return no windows.

    @@ -368,7 +368,7 @@ error before this method gets stabilized.

    assert_eq!(iter.next().unwrap(), &[1, 2]); assert_eq!(iter.next().unwrap(), &[2, 3]); assert!(iter.next().is_none());
    -
    1.31.0 · source

    pub fn rchunks(&self, chunk_size: usize) -> RChunks<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the end +

    1.31.0 · source

    pub fn rchunks(&self, chunk_size: usize) -> RChunks<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

    @@ -384,7 +384,7 @@ of the slice.

    assert_eq!(iter.next().unwrap(), &['o', 'r']); assert_eq!(iter.next().unwrap(), &['l']); assert!(iter.next().is_none());
    -
    1.31.0 · source

    pub fn rchunks_exact(&self, chunk_size: usize) -> RChunksExact<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the +

    1.31.0 · source

    pub fn rchunks_exact(&self, chunk_size: usize) -> RChunksExact<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved @@ -403,7 +403,7 @@ slice.

    assert_eq!(iter.next().unwrap(), &['o', 'r']); assert!(iter.next().is_none()); assert_eq!(iter.remainder(), &['l']);
    -
    1.77.0 · source

    pub fn chunk_by<F>(&self, pred: F) -> ChunkBy<'_, T, F> ⓘ
    where +

    1.77.0 · source

    pub fn chunk_by<F>(&self, pred: F) -> ChunkBy<'_, T, F>
    where F: FnMut(&T, &T) -> bool,

    Returns an iterator over the slice producing non-overlapping runs of elements using the predicate to separate them.

    The predicate is called for every pair of consecutive elements, @@ -517,7 +517,7 @@ second will contain all indices from [mid, len) (excluding the inde } assert_eq!(None, v.split_at_checked(7));

    -
    1.0.0 · source

    pub fn split<F>(&self, pred: F) -> Split<'_, T, F> ⓘ
    where +

    1.0.0 · source

    pub fn split<F>(&self, pred: F) -> Split<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred. The matched element is not contained in the subslices.

    §Examples
    @@ -548,7 +548,7 @@ present between them:

    assert_eq!(iter.next().unwrap(), &[]); assert_eq!(iter.next().unwrap(), &[20]); assert!(iter.next().is_none());
    -
    1.51.0 · source

    pub fn split_inclusive<F>(&self, pred: F) -> SplitInclusive<'_, T, F> ⓘ
    where +

    1.51.0 · source

    pub fn split_inclusive<F>(&self, pred: F) -> SplitInclusive<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred. The matched element is contained in the end of the previous subslice as a terminator.

    @@ -569,7 +569,7 @@ That slice will be the last item returned by the iterator.

    assert_eq!(iter.next().unwrap(), &[3]); assert_eq!(iter.next().unwrap(), &[10, 40, 33]); assert!(iter.next().is_none());
    -
    1.27.0 · source

    pub fn rsplit<F>(&self, pred: F) -> RSplit<'_, T, F> ⓘ
    where +

    1.27.0 · source

    pub fn rsplit<F>(&self, pred: F) -> RSplit<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred, starting at the end of the slice and working backwards. The matched element is not contained in the subslices.

    @@ -590,7 +590,7 @@ slice will be the first (or last) item returned by the iterator.

    assert_eq!(it.next().unwrap(), &[1, 1]); assert_eq!(it.next().unwrap(), &[]); assert_eq!(it.next(), None);
    -
    1.0.0 · source

    pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<'_, T, F> ⓘ
    where +

    1.0.0 · source

    pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

    @@ -605,7 +605,7 @@ slice.

    for group in v.splitn(2, |num| *num % 3 == 0) { println!("{group:?}"); }
    -
    1.0.0 · source

    pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<'_, T, F> ⓘ
    where +

    1.0.0 · source

    pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in @@ -1012,12 +1012,12 @@ types, and thus tends to be irrelevant in practice. If let empty_slice_of_arrays: &[[u32; 10]] = &[]; assert!(empty_slice_of_arrays.flatten().is_empty());

    -
    1.23.0 · source

    pub fn to_ascii_uppercase(&self) -> Vec<u8> ⓘ

    Returns a vector containing a copy of this slice where each byte +

    1.23.0 · source

    pub fn to_ascii_uppercase(&self) -> Vec<u8>

    Returns a vector containing a copy of this slice where each byte is mapped to its ASCII upper case equivalent.

    ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

    To uppercase the value in-place, use make_ascii_uppercase.

    -
    1.23.0 · source

    pub fn to_ascii_lowercase(&self) -> Vec<u8> ⓘ

    Returns a vector containing a copy of this slice where each byte +

    1.23.0 · source

    pub fn to_ascii_lowercase(&self) -> Vec<u8>

    Returns a vector containing a copy of this slice where each byte is mapped to its ASCII lower case equivalent.

    ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

    @@ -1076,51 +1076,51 @@ given separator between each.

    §Examples
    assert_eq!(["hello", "world"].connect(" "), "hello world");
 assert_eq!([[1, 2], [3, 4]].connect(&0), [1, 2, 0, 3, 4]);
    -

    Trait Implementations§

    source§

    impl<'a> AsBStr for &'a BStr

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl AsRef<[u8]> for BStr

    source§

    fn as_ref(&self) -> &[u8] ⓘ

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<BStr> for [u8]

    source§

    fn as_ref(&self) -> &BStr

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<BStr> for str

    source§

    fn as_ref(&self) -> &BStr

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl Borrow<BStr> for Vec<u8>

    source§

    fn borrow(&self) -> &BStr

    Immutably borrows from an owned value. Read more
    source§

    impl<'a, T> Compare<T> for &'a BStr
    where - &'a [u8]: Compare<T>,

    source§

    fn compare(&self, t: T) -> CompareResult

    Compares self to another value for equality
    source§

    impl Debug for BStr

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'a> Default for &'a BStr

    source§

    fn default() -> &'a BStr

    Returns the “default value” for a type. Read more
    source§

    impl Deref for BStr

    §

    type Target = [u8]

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &[u8] ⓘ

    Dereferences the value.
    source§

    impl Display for BStr

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'i, S> FindSlice<S> for &'i BStr
    where - &'i [u8]: FindSlice<S>,

    source§

    fn find_slice(&self, substr: S) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<'a> From<&'a [u8]> for &'a BStr

    source§

    fn from(s: &'a [u8]) -> &'a BStr

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a BStr> for &'a [u8]

    source§

    fn from(s: &'a BStr) -> &'a [u8] ⓘ

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a str> for &'a BStr

    source§

    fn from(s: &'a str) -> &'a BStr

    Converts to this type from the input type.
    source§

    impl Hash for BStr

    source§

    fn hash<__H: Hasher>(&self, state: &mut __H)

    Feeds this value into the given Hasher. Read more
    source§

    impl Index<Range<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: Range<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFrom<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeFrom<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFull> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, _: RangeFull) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeInclusive<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeInclusive<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeTo<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeTo<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeToInclusive<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeToInclusive<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<usize> for BStr

    §

    type Output = u8

    The returned type after indexing.
    source§

    fn index(&self, idx: usize) -> &u8

    Performs the indexing (container[index]) operation. Read more
    source§

    impl<'a> Offset<<&'a BStr as Stream>::Checkpoint> for &'a BStr

    source§

    fn offset_from(&self, other: &<&'a BStr as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<'a> Offset for &'a BStr

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl Ord for BStr

    source§

    fn cmp(&self, other: &BStr) -> Ordering

    This method returns an Ordering between self and other. Read more
    source§

    impl<'a, 'b> PartialEq<&'a [u8]> for BStr

    source§

    fn eq(&self, other: &&'a [u8]) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<&'a str> for BStr

    source§

    fn eq(&self, other: &&'a str) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<[u8]> for BStr

    source§

    fn eq(&self, other: &[u8]) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<BStr> for &'a [u8]

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<BStr> for &'a str

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<BStr> for [u8]

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<BStr> for str

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<str> for BStr

    source§

    fn eq(&self, other: &str) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl PartialEq for BStr

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used +

    Trait Implementations§

    source§

    impl<'a> AsBStr for &'a BStr

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl AsRef<[u8]> for BStr

    source§

    fn as_ref(&self) -> &[u8] ⓘ

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<BStr> for [u8]

    source§

    fn as_ref(&self) -> &BStr

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<BStr> for str

    source§

    fn as_ref(&self) -> &BStr

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl Borrow<BStr> for Vec<u8>

    source§

    fn borrow(&self) -> &BStr

    Immutably borrows from an owned value. Read more
    source§

    impl<'a, T> Compare<T> for &'a BStr
    where + &'a [u8]: Compare<T>,

    source§

    fn compare(&self, t: T) -> CompareResult

    Compares self to another value for equality
    source§

    impl Debug for BStr

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'a> Default for &'a BStr

    source§

    fn default() -> &'a BStr

    Returns the “default value” for a type. Read more
    source§

    impl Deref for BStr

    §

    type Target = [u8]

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &[u8] ⓘ

    Dereferences the value.
    source§

    impl Display for BStr

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'i, S> FindSlice<S> for &'i BStr
    where + &'i [u8]: FindSlice<S>,

    source§

    fn find_slice(&self, substr: S) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<'a> From<&'a [u8]> for &'a BStr

    source§

    fn from(s: &'a [u8]) -> &'a BStr

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a BStr> for &'a [u8]

    source§

    fn from(s: &'a BStr) -> &'a [u8] ⓘ

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a str> for &'a BStr

    source§

    fn from(s: &'a str) -> &'a BStr

    Converts to this type from the input type.
    source§

    impl Hash for BStr

    source§

    fn hash<__H: Hasher>(&self, state: &mut __H)

    Feeds this value into the given Hasher. Read more
    source§

    impl Index<Range<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: Range<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFrom<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeFrom<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFull> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, _: RangeFull) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeInclusive<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeInclusive<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeTo<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeTo<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeToInclusive<usize>> for BStr

    §

    type Output = BStr

    The returned type after indexing.
    source§

    fn index(&self, r: RangeToInclusive<usize>) -> &BStr

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<usize> for BStr

    §

    type Output = u8

    The returned type after indexing.
    source§

    fn index(&self, idx: usize) -> &u8

    Performs the indexing (container[index]) operation. Read more
    source§

    impl<'a> Offset<<&'a BStr as Stream>::Checkpoint> for &'a BStr

    source§

    fn offset_from(&self, other: &<&'a BStr as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<'a> Offset for &'a BStr

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl Ord for BStr

    source§

    fn cmp(&self, other: &BStr) -> Ordering

    This method returns an Ordering between self and other. Read more
    source§

    impl<'a> PartialEq<&'a [u8]> for BStr

    source§

    fn eq(&self, other: &&'a [u8]) -> bool

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialOrd<&'a [u8]> for BStr

    source§

    fn partial_cmp(&self, other: &&'a [u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<&'a str> for BStr

    source§

    fn partial_cmp(&self, other: &&'a str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<[u8]> for BStr

    source§

    fn partial_cmp(&self, other: &[u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<BStr> for &'a [u8]

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<&'a str> for BStr

    source§

    fn eq(&self, other: &&'a str) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<[u8]> for BStr

    source§

    fn eq(&self, other: &[u8]) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<BStr> for &'a [u8]

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<BStr> for &'a str

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<BStr> for [u8]

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<BStr> for str

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<str> for BStr

    source§

    fn eq(&self, other: &str) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl PartialEq for BStr

    source§

    fn eq(&self, other: &BStr) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialOrd<&'a [u8]> for BStr

    source§

    fn partial_cmp(&self, other: &&'a [u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<BStr> for &'a str

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<BStr> for [u8]

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<BStr> for str

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<str> for BStr

    source§

    fn partial_cmp(&self, other: &str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl PartialOrd for BStr

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    source§

    impl<'a> PartialOrd<&'a str> for BStr

    source§

    fn partial_cmp(&self, other: &&'a str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a> SliceLen for &'a BStr

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, -and the name of the trait itself
    source§

    impl<'i> Stream for &'i BStr

    §

    type Token = u8

    The smallest unit being parsed Read more
    §

    type Slice = &'i [u8]

    Sequence of Tokens Read more
    §

    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<&'i BStr, &'i BStr>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where - P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn peek_token(&self) -> Option<(Self, Self::Token)>
    where - Self: Clone,

    Split off the next token from the input
    source§

    fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
    where - Self: Clone,

    Split off a slice of tokens from the input
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    fn peek_finish(&self) -> (Self, Self::Slice)
    where - Self: Clone,

    Advance to the end of the stream
    source§

    impl<'a> StreamIsPartial for &'a BStr

    §

    type PartialState = ()

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, _state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl ToOwned for BStr

    §

    type Owned = Vec<u8>

    The resulting type after obtaining ownership.
    source§

    fn to_owned(&self) -> Self::Owned

    Creates owned data from borrowed data, usually by cloning. Read more
    1.63.0 · source§

    fn clone_into(&self, target: &mut Self::Owned)

    Uses borrowed data to replace owned data, usually by cloning. Read more
    source§

    impl<'a> UpdateSlice for &'a BStr

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl Eq for BStr

    Auto Trait Implementations§

    §

    impl Freeze for BStr

    §

    impl RefUnwindSafe for BStr

    §

    impl Send for BStr

    §

    impl !Sized for BStr

    §

    impl Sync for BStr

    §

    impl Unpin for BStr

    §

    impl UnwindSafe for BStr

    Blanket Implementations§

    source§

    impl<T> Any for T
    where +operator. Read more

    source§

    impl<'a> PartialOrd<[u8]> for BStr

    source§

    fn partial_cmp(&self, other: &[u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<BStr> for &'a [u8]

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<BStr> for &'a str

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<BStr> for [u8]

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<BStr> for str

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<str> for BStr

    source§

    fn partial_cmp(&self, other: &str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl PartialOrd for BStr

    source§

    fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> SliceLen for &'a BStr

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, +and the name of the trait itself
    source§

    impl<'i> Stream for &'i BStr

    §

    type Token = u8

    The smallest unit being parsed Read more
    §

    type Slice = &'i [u8]

    Sequence of Tokens Read more
    §

    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<&'i BStr, &'i BStr>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn peek_token(&self) -> Option<(Self, Self::Token)>
    where + Self: Clone,

    Split off the next token from the input
    source§

    fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
    where + Self: Clone,

    Split off a slice of tokens from the input
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    fn peek_finish(&self) -> (Self, Self::Slice)
    where + Self: Clone,

    Advance to the end of the stream
    source§

    impl<'a> StreamIsPartial for &'a BStr

    §

    type PartialState = ()

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, _state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl ToOwned for BStr

    §

    type Owned = Vec<u8>

    The resulting type after obtaining ownership.
    source§

    fn to_owned(&self) -> Self::Owned

    Creates owned data from borrowed data, usually by cloning. Read more
    1.63.0 · source§

    fn clone_into(&self, target: &mut Self::Owned)

    Uses borrowed data to replace owned data, usually by cloning. Read more
    source§

    impl<'a> UpdateSlice for &'a BStr

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl Eq for BStr

    Auto Trait Implementations§

    §

    impl Freeze for BStr

    §

    impl RefUnwindSafe for BStr

    §

    impl Send for BStr

    §

    impl !Sized for BStr

    §

    impl Sync for BStr

    §

    impl Unpin for BStr

    §

    impl UnwindSafe for BStr

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    source§

    impl<T> ToString for T
    where - T: Display + ?Sized,

    source§

    default fn to_string(&self) -> String

    Converts the given value to a String. Read more
    \ No newline at end of file + T: Display + ?Sized,
    source§

    default fn to_string(&self) -> String

    Converts the given value to a String. Read more
    \ No newline at end of file diff --git a/winnow/stream/struct.BitOffsets.html b/winnow/stream/struct.BitOffsets.html index 56993d7d9..6ef319838 100644 --- a/winnow/stream/struct.BitOffsets.html +++ b/winnow/stream/struct.BitOffsets.html @@ -1,56 +1,56 @@ -BitOffsets in winnow::stream - Rust
    -

    Struct winnow::stream::BitOffsets

    source · 
    pub struct BitOffsets<I> { /* private fields */ }
    Expand description

    Iterator for bit stream ((I, usize))

    -

    Trait Implementations§

    source§

    impl<I> Iterator for BitOffsets<I>
    where - I: Stream<Token = u8> + Clone,

    §

    type Item = (usize, bool)

    The type of the elements being iterated over.
    source§

    fn next(&mut self) -> Option<Self::Item>

    Advances the iterator and returns the next value. Read more
    source§

    fn next_chunk<const N: usize>( +BitOffsets in winnow::stream - Rust
    +

    Struct winnow::stream::BitOffsets

    source · 
    pub struct BitOffsets<I> { /* private fields */ }
    Expand description

    Iterator for bit stream ((I, usize))

    +

    Trait Implementations§

    source§

    impl<I> Iterator for BitOffsets<I>
    where + I: Stream<Token = u8> + Clone,

    §

    type Item = (usize, bool)

    The type of the elements being iterated over.
    source§

    fn next(&mut self) -> Option<Self::Item>

    Advances the iterator and returns the next value. Read more
    source§

    fn next_chunk<const N: usize>( &mut self ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>
    where Self: Sized,

    🔬This is a nightly-only experimental API. (iter_next_chunk)
    Advances the iterator and returns an array containing the next N values. Read more
    1.0.0 · source§

    fn size_hint(&self) -> (usize, Option<usize>)

    Returns the bounds on the remaining length of the iterator. Read more
    1.0.0 · source§

    fn count(self) -> usize
    where Self: Sized,

    Consumes the iterator, counting the number of iterations and returning it. Read more
    1.0.0 · source§

    fn last(self) -> Option<Self::Item>
    where - Self: Sized,

    Consumes the iterator, returning the last element. Read more
    source§

    fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

    🔬This is a nightly-only experimental API. (iter_advance_by)
    Advances the iterator by n elements. Read more
    1.0.0 · source§

    fn nth(&mut self, n: usize) -> Option<Self::Item>

    Returns the nth element of the iterator. Read more
    1.28.0 · source§

    fn step_by(self, step: usize) -> StepBy<Self> ⓘ
    where + Self: Sized,

    Consumes the iterator, returning the last element. Read more
    source§

    fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

    🔬This is a nightly-only experimental API. (iter_advance_by)
    Advances the iterator by n elements. Read more
    1.0.0 · source§

    fn nth(&mut self, n: usize) -> Option<Self::Item>

    Returns the nth element of the iterator. Read more
    1.28.0 · source§

    fn step_by(self, step: usize) -> StepBy<Self>
    where Self: Sized,

    Creates an iterator starting at the same point, but stepping by -the given amount at each iteration. Read more
    1.0.0 · source§

    fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> ⓘ
    where +the given amount at each iteration. Read more

    1.0.0 · source§

    fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
    where Self: Sized, - U: IntoIterator<Item = Self::Item>,

    Takes two iterators and creates a new iterator over both in sequence. Read more
    1.0.0 · source§

    fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> ⓘ
    where + U: IntoIterator<Item = Self::Item>,

    Takes two iterators and creates a new iterator over both in sequence. Read more
    1.0.0 · source§

    fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>
    where Self: Sized, - U: IntoIterator,

    ‘Zips up’ two iterators into a single iterator of pairs. Read more
    source§

    fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> ⓘ
    where + U: IntoIterator,

    ‘Zips up’ two iterators into a single iterator of pairs. Read more
    source§

    fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
    where Self: Sized, G: FnMut() -> Self::Item,

    🔬This is a nightly-only experimental API. (iter_intersperse)
    Creates a new iterator which places an item generated by separator -between adjacent items of the original iterator. Read more
    1.0.0 · source§

    fn map<B, F>(self, f: F) -> Map<Self, F> ⓘ
    where +between adjacent items of the original iterator. Read more

    1.0.0 · source§

    fn map<B, F>(self, f: F) -> Map<Self, F>
    where Self: Sized, F: FnMut(Self::Item) -> B,

    Takes a closure and creates an iterator which calls that closure on each element. Read more
    1.21.0 · source§

    fn for_each<F>(self, f: F)
    where Self: Sized, - F: FnMut(Self::Item),

    Calls a closure on each element of an iterator. Read more
    1.0.0 · source§

    fn filter<P>(self, predicate: P) -> Filter<Self, P> ⓘ
    where + F: FnMut(Self::Item),

    Calls a closure on each element of an iterator. Read more
    1.0.0 · source§

    fn filter<P>(self, predicate: P) -> Filter<Self, P>
    where Self: Sized, P: FnMut(&Self::Item) -> bool,

    Creates an iterator which uses a closure to determine if an element -should be yielded. Read more
    1.0.0 · source§

    fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> ⓘ
    where +should be yielded. Read more

    1.0.0 · source§

    fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
    where Self: Sized, - F: FnMut(Self::Item) -> Option<B>,

    Creates an iterator that both filters and maps. Read more
    1.0.0 · source§

    fn enumerate(self) -> Enumerate<Self> ⓘ
    where + F: FnMut(Self::Item) -> Option<B>,

    Creates an iterator that both filters and maps. Read more
    1.0.0 · source§

    fn enumerate(self) -> Enumerate<Self>
    where Self: Sized,

    Creates an iterator which gives the current iteration count as well as -the next value. Read more
    1.0.0 · source§

    fn peekable(self) -> Peekable<Self> ⓘ
    where +the next value. Read more

    1.0.0 · source§

    fn peekable(self) -> Peekable<Self>
    where Self: Sized,

    Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See -their documentation for more information. Read more
    1.0.0 · source§

    fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> ⓘ
    where +their documentation for more information. Read more

    1.0.0 · source§

    fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
    where Self: Sized, - P: FnMut(&Self::Item) -> bool,

    Creates an iterator that skips elements based on a predicate. Read more
    1.0.0 · source§

    fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> ⓘ
    where + P: FnMut(&Self::Item) -> bool,

    Creates an iterator that skips elements based on a predicate. Read more
    1.0.0 · source§

    fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
    where Self: Sized, - P: FnMut(&Self::Item) -> bool,

    Creates an iterator that yields elements based on a predicate. Read more
    1.57.0 · source§

    fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> ⓘ
    where + P: FnMut(&Self::Item) -> bool,

    Creates an iterator that yields elements based on a predicate. Read more
    1.57.0 · source§

    fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
    where Self: Sized, - P: FnMut(Self::Item) -> Option<B>,

    Creates an iterator that both yields elements based on a predicate and maps. Read more
    1.0.0 · source§

    fn skip(self, n: usize) -> Skip<Self> ⓘ
    where - Self: Sized,

    Creates an iterator that skips the first n elements. Read more
    1.0.0 · source§

    fn take(self, n: usize) -> Take<Self> ⓘ
    where + P: FnMut(Self::Item) -> Option<B>,

    Creates an iterator that both yields elements based on a predicate and maps. Read more
    1.0.0 · source§

    fn skip(self, n: usize) -> Skip<Self>
    where + Self: Sized,

    Creates an iterator that skips the first n elements. Read more
    1.0.0 · source§

    fn take(self, n: usize) -> Take<Self>
    where Self: Sized,

    Creates an iterator that yields the first n elements, or fewer -if the underlying iterator ends sooner. Read more
    1.0.0 · source§

    fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> ⓘ
    where +if the underlying iterator ends sooner. Read more

    1.0.0 · source§

    fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
    where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

    An iterator adapter which, like fold, holds internal state, but -unlike fold, produces a new iterator. Read more
    1.0.0 · source§

    fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> ⓘ
    where +unlike fold, produces a new iterator. Read more

    1.0.0 · source§

    fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
    where Self: Sized, U: IntoIterator, - F: FnMut(Self::Item) -> U,

    Creates an iterator that works like map, but flattens nested structure. Read more
    source§

    fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N> ⓘ
    where + F: FnMut(Self::Item) -> U,

    Creates an iterator that works like map, but flattens nested structure. Read more
    source§

    fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
    where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

    🔬This is a nightly-only experimental API. (iter_map_windows)
    Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), -the windows during mapping overlap as well. Read more
    1.0.0 · source§

    fn fuse(self) -> Fuse<Self> ⓘ
    where - Self: Sized,

    Creates an iterator which ends after the first None. Read more
    1.0.0 · source§

    fn inspect<F>(self, f: F) -> Inspect<Self, F> ⓘ
    where +the windows during mapping overlap as well. Read more

    1.0.0 · source§

    fn fuse(self) -> Fuse<Self>
    where + Self: Sized,

    Creates an iterator which ends after the first None. Read more
    1.0.0 · source§

    fn inspect<F>(self, f: F) -> Inspect<Self, F>
    where Self: Sized, F: FnMut(&Self::Item),

    Does something with each element of an iterator, passing the value on. Read more
    1.0.0 · source§

    fn by_ref(&mut self) -> &mut Self
    where Self: Sized,

    Borrows an iterator, rather than consuming it. Read more
    1.0.0 · source§

    fn collect<B>(self) -> B
    where @@ -121,11 +121,11 @@ specified function. Read more

    1.0.0 · source§

    fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
    where FromA: Default + Extend<A>, FromB: Default + Extend<B>, - Self: Sized + Iterator<Item = (A, B)>,

    Converts an iterator of pairs into a pair of containers. Read more
    1.36.0 · source§

    fn copied<'a, T>(self) -> Copied<Self> ⓘ
    where + Self: Sized + Iterator<Item = (A, B)>,

    Converts an iterator of pairs into a pair of containers. Read more
    1.36.0 · source§

    fn copied<'a, T>(self) -> Copied<Self>
    where T: 'a + Copy, - Self: Sized + Iterator<Item = &'a T>,

    Creates an iterator which copies all of its elements. Read more
    1.0.0 · source§

    fn cloned<'a, T>(self) -> Cloned<Self> ⓘ
    where + Self: Sized + Iterator<Item = &'a T>,

    Creates an iterator which copies all of its elements. Read more
    1.0.0 · source§

    fn cloned<'a, T>(self) -> Cloned<Self>
    where T: 'a + Clone, - Self: Sized + Iterator<Item = &'a T>,

    Creates an iterator which clones all of its elements. Read more
    source§

    fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N> ⓘ
    where + Self: Sized + Iterator<Item = &'a T>,

    Creates an iterator which clones all of its elements. Read more
    source§

    fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>
    where Self: Sized,

    🔬This is a nightly-only experimental API. (iter_array_chunks)
    Returns an iterator over N elements of the iterator at a time. Read more
    1.11.0 · source§

    fn sum<S>(self) -> S
    where Self: Sized, S: Sum<Self::Item>,

    Sums the elements of an iterator. Read more
    1.11.0 · source§

    fn product<P>(self) -> P
    where @@ -195,4 +195,4 @@ function.
    source§

    impl<I> IntoIterator for I
    where I: Iterator,

    §

    type Item = <I as Iterator>::Item

    The type of the elements being iterated over.
    §

    type IntoIter = I

    Which kind of iterator are we turning this into?
    const: unstable · source§

    fn into_iter(self) -> I

    Creates an iterator from a value. Read more

    source§

    impl<T, U> TryFrom<U> for T
    where U: Into<T>,

    §

    type Error = Infallible

    The type returned in the event of a conversion error.
    source§

    fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

    Performs the conversion.
    source§

    impl<T, U> TryInto<U> for T
    where - U: TryFrom<T>,

    §

    type Error = <U as TryFrom<T>>::Error

    The type returned in the event of a conversion error.
    source§

    fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

    Performs the conversion.
    \ No newline at end of file + U: TryFrom<T>,

    §

    type Error = <U as TryFrom<T>>::Error

    The type returned in the event of a conversion error.
    source§

    fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

    Performs the conversion.
    \ No newline at end of file diff --git a/winnow/stream/struct.Bytes.html b/winnow/stream/struct.Bytes.html index 5da8ac0fa..9af89d5cf 100644 --- a/winnow/stream/struct.Bytes.html +++ b/winnow/stream/struct.Bytes.html @@ -1,6 +1,6 @@ -Bytes in winnow::stream - Rust
    -

    Struct winnow::stream::Bytes

    source · 
    pub struct Bytes(/* private fields */);
    Expand description

    Improved Debug experience for &[u8] byte streams

    -

    Implementations§

    source§

    impl Bytes

    source

    pub fn new<B: ?Sized + AsRef<[u8]>>(bytes: &B) -> &Self

    Make a stream out of a byte slice-like.

    +Bytes in winnow::stream - Rust
    +

    Struct winnow::stream::Bytes

    source · 
    pub struct Bytes(/* private fields */);
    Expand description

    Improved Debug experience for &[u8] byte streams

    +

    Implementations§

    source§

    impl Bytes

    source

    pub fn new<B: ?Sized + AsRef<[u8]>>(bytes: &B) -> &Self

    Make a stream out of a byte slice-like.

    Methods from Deref<Target = [u8]>§

    1.23.0 · source

    pub fn is_ascii(&self) -> bool

    Checks if all bytes in this slice are within the ASCII range.

    source

    pub fn as_ascii(&self) -> Option<&[AsciiChar]>

    🔬This is a nightly-only experimental API. (ascii_char)

    If this slice is_ascii, returns it as a slice of ASCII characters, otherwise returns None.

    @@ -11,7 +11,7 @@ without checking whether they’re valid.

    1.23.0 · source

    pub fn eq_ignore_ascii_case(&self, other: &[u8]) -> bool

    Checks that two slices are an ASCII case-insensitive match.

    Same as to_ascii_lowercase(a) == to_ascii_lowercase(b), but without allocating and copying temporaries.

    -
    1.60.0 · source

    pub fn escape_ascii(&self) -> EscapeAscii<'_> ⓘ

    Returns an iterator that produces an escaped version of this slice, +

    1.60.0 · source

    pub fn escape_ascii(&self) -> EscapeAscii<'_>

    Returns an iterator that produces an escaped version of this slice, treating it as an ASCII string.

    §Examples
    
@@ -185,7 +185,7 @@ to be reallocated, which would also make any pointers to it invalid.
    
         assert_eq!(x.get_unchecked(i), &*x_ptr.add(i));
     }
 }
    -
    1.48.0 · source

    pub fn as_ptr_range(&self) -> Range<*const T> ⓘ

    Returns the two raw pointers spanning the slice.

    +
    1.48.0 · source

    pub fn as_ptr_range(&self) -> Range<*const T>

    Returns the two raw pointers spanning the slice.

    The returned range is half-open, which means that the end pointer points one past the last element of the slice. This way, an empty slice is represented by two equal pointers, and the difference between @@ -205,7 +205,7 @@ element of this slice:

    assert!(a.as_ptr_range().contains(&x)); assert!(!a.as_ptr_range().contains(&y));
    -
    1.0.0 · source

    pub fn iter(&self) -> Iter<'_, T> ⓘ

    Returns an iterator over the slice.

    +
    1.0.0 · source

    pub fn iter(&self) -> Iter<'_, T>

    Returns an iterator over the slice.

    The iterator yields all items from start to end.

    §Examples
    let x = &[1, 2, 4];
@@ -215,7 +215,7 @@ element of this slice:
    
 assert_eq!(iterator.next(), Some(&2));
 assert_eq!(iterator.next(), Some(&4));
 assert_eq!(iterator.next(), None);
    -
    1.0.0 · source

    pub fn windows(&self, size: usize) -> Windows<'_, T> ⓘ

    Returns an iterator over all contiguous windows of length +

    1.0.0 · source

    pub fn windows(&self, size: usize) -> Windows<'_, T>

    Returns an iterator over all contiguous windows of length size. The windows overlap. If the slice is shorter than size, the iterator returns no values.

    §Panics
    @@ -246,7 +246,7 @@ conjunction with windows to accomplish something similar:

    Cell::swap(&w[0], &w[2]); } assert_eq!(array, ['s', 't', ' ', '2', '0', '1', '5', 'u', 'R']);
    -
    1.0.0 · source

    pub fn chunks(&self, chunk_size: usize) -> Chunks<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the +

    1.0.0 · source

    pub fn chunks(&self, chunk_size: usize) -> Chunks<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

    @@ -262,7 +262,7 @@ slice.

    assert_eq!(iter.next().unwrap(), &['r', 'e']); assert_eq!(iter.next().unwrap(), &['m']); assert!(iter.next().is_none());
    -
    1.31.0 · source

    pub fn chunks_exact(&self, chunk_size: usize) -> ChunksExact<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the +

    1.31.0 · source

    pub fn chunks_exact(&self, chunk_size: usize) -> ChunksExact<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved @@ -336,7 +336,7 @@ error before this method gets stabilized.

    let (remainder, chunks) = slice.as_rchunks(); assert_eq!(remainder, &['l']); assert_eq!(chunks, &[['o', 'r'], ['e', 'm']]);
    -
    source

    pub fn array_chunks<const N: usize>(&self) -> ArrayChunks<'_, T, N> ⓘ

    🔬This is a nightly-only experimental API. (array_chunks)

    Returns an iterator over N elements of the slice at a time, starting at the +

    source

    pub fn array_chunks<const N: usize>(&self) -> ArrayChunks<'_, T, N>

    🔬This is a nightly-only experimental API. (array_chunks)

    Returns an iterator over N elements of the slice at a time, starting at the beginning of the slice.

    The chunks are array references and do not overlap. If N does not divide the length of the slice, then the last up to N-1 elements will be omitted and can be @@ -353,7 +353,7 @@ error before this method gets stabilized.

    assert_eq!(iter.next().unwrap(), &['r', 'e']); assert!(iter.next().is_none()); assert_eq!(iter.remainder(), &['m']);
    -
    source

    pub fn array_windows<const N: usize>(&self) -> ArrayWindows<'_, T, N> ⓘ

    🔬This is a nightly-only experimental API. (array_windows)

    Returns an iterator over overlapping windows of N elements of a slice, +

    source

    pub fn array_windows<const N: usize>(&self) -> ArrayWindows<'_, T, N>

    🔬This is a nightly-only experimental API. (array_windows)

    Returns an iterator over overlapping windows of N elements of a slice, starting at the beginning of the slice.

    This is the const generic equivalent of windows.

    If N is greater than the size of the slice, it will return no windows.

    @@ -368,7 +368,7 @@ error before this method gets stabilized.

    assert_eq!(iter.next().unwrap(), &[1, 2]); assert_eq!(iter.next().unwrap(), &[2, 3]); assert!(iter.next().is_none());
    -
    1.31.0 · source

    pub fn rchunks(&self, chunk_size: usize) -> RChunks<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the end +

    1.31.0 · source

    pub fn rchunks(&self, chunk_size: usize) -> RChunks<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

    @@ -384,7 +384,7 @@ of the slice.

    assert_eq!(iter.next().unwrap(), &['o', 'r']); assert_eq!(iter.next().unwrap(), &['l']); assert!(iter.next().is_none());
    -
    1.31.0 · source

    pub fn rchunks_exact(&self, chunk_size: usize) -> RChunksExact<'_, T> ⓘ

    Returns an iterator over chunk_size elements of the slice at a time, starting at the +

    1.31.0 · source

    pub fn rchunks_exact(&self, chunk_size: usize) -> RChunksExact<'_, T>

    Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

    The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved @@ -403,7 +403,7 @@ slice.

    assert_eq!(iter.next().unwrap(), &['o', 'r']); assert!(iter.next().is_none()); assert_eq!(iter.remainder(), &['l']);
    -
    1.77.0 · source

    pub fn chunk_by<F>(&self, pred: F) -> ChunkBy<'_, T, F> ⓘ
    where +

    1.77.0 · source

    pub fn chunk_by<F>(&self, pred: F) -> ChunkBy<'_, T, F>
    where F: FnMut(&T, &T) -> bool,

    Returns an iterator over the slice producing non-overlapping runs of elements using the predicate to separate them.

    The predicate is called for every pair of consecutive elements, @@ -517,7 +517,7 @@ second will contain all indices from [mid, len) (excluding the inde } assert_eq!(None, v.split_at_checked(7));

    -
    1.0.0 · source

    pub fn split<F>(&self, pred: F) -> Split<'_, T, F> ⓘ
    where +

    1.0.0 · source

    pub fn split<F>(&self, pred: F) -> Split<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred. The matched element is not contained in the subslices.

    §Examples
    @@ -548,7 +548,7 @@ present between them:

    assert_eq!(iter.next().unwrap(), &[]); assert_eq!(iter.next().unwrap(), &[20]); assert!(iter.next().is_none());
    -
    1.51.0 · source

    pub fn split_inclusive<F>(&self, pred: F) -> SplitInclusive<'_, T, F> ⓘ
    where +

    1.51.0 · source

    pub fn split_inclusive<F>(&self, pred: F) -> SplitInclusive<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred. The matched element is contained in the end of the previous subslice as a terminator.

    @@ -569,7 +569,7 @@ That slice will be the last item returned by the iterator.

    assert_eq!(iter.next().unwrap(), &[3]); assert_eq!(iter.next().unwrap(), &[10, 40, 33]); assert!(iter.next().is_none());
    -
    1.27.0 · source

    pub fn rsplit<F>(&self, pred: F) -> RSplit<'_, T, F> ⓘ
    where +

    1.27.0 · source

    pub fn rsplit<F>(&self, pred: F) -> RSplit<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred, starting at the end of the slice and working backwards. The matched element is not contained in the subslices.

    @@ -590,7 +590,7 @@ slice will be the first (or last) item returned by the iterator.

    assert_eq!(it.next().unwrap(), &[1, 1]); assert_eq!(it.next().unwrap(), &[]); assert_eq!(it.next(), None);
    -
    1.0.0 · source

    pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<'_, T, F> ⓘ
    where +

    1.0.0 · source

    pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

    @@ -605,7 +605,7 @@ slice.

    for group in v.splitn(2, |num| *num % 3 == 0) { println!("{group:?}"); }
    -
    1.0.0 · source

    pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<'_, T, F> ⓘ
    where +

    1.0.0 · source

    pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<'_, T, F>
    where F: FnMut(&T) -> bool,

    Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in @@ -1012,12 +1012,12 @@ types, and thus tends to be irrelevant in practice. If let empty_slice_of_arrays: &[[u32; 10]] = &[]; assert!(empty_slice_of_arrays.flatten().is_empty());

    -
    1.23.0 · source

    pub fn to_ascii_uppercase(&self) -> Vec<u8> ⓘ

    Returns a vector containing a copy of this slice where each byte +

    1.23.0 · source

    pub fn to_ascii_uppercase(&self) -> Vec<u8>

    Returns a vector containing a copy of this slice where each byte is mapped to its ASCII upper case equivalent.

    ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

    To uppercase the value in-place, use make_ascii_uppercase.

    -
    1.23.0 · source

    pub fn to_ascii_lowercase(&self) -> Vec<u8> ⓘ

    Returns a vector containing a copy of this slice where each byte +

    1.23.0 · source

    pub fn to_ascii_lowercase(&self) -> Vec<u8>

    Returns a vector containing a copy of this slice where each byte is mapped to its ASCII lower case equivalent.

    ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

    @@ -1076,51 +1076,51 @@ given separator between each.

    §Examples
    assert_eq!(["hello", "world"].connect(" "), "hello world");
 assert_eq!([[1, 2], [3, 4]].connect(&0), [1, 2, 0, 3, 4]);
    -

    Trait Implementations§

    source§

    impl<'a> AsBytes for &'a Bytes

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl AsRef<[u8]> for Bytes

    source§

    fn as_ref(&self) -> &[u8] ⓘ

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<Bytes> for [u8]

    source§

    fn as_ref(&self) -> &Bytes

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<Bytes> for str

    source§

    fn as_ref(&self) -> &Bytes

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl Borrow<Bytes> for Vec<u8>

    source§

    fn borrow(&self) -> &Bytes

    Immutably borrows from an owned value. Read more
    source§

    impl<'a, T> Compare<T> for &'a Bytes
    where - &'a [u8]: Compare<T>,

    source§

    fn compare(&self, t: T) -> CompareResult

    Compares self to another value for equality
    source§

    impl Debug for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'a> Default for &'a Bytes

    source§

    fn default() -> &'a Bytes

    Returns the “default value” for a type. Read more
    source§

    impl Deref for Bytes

    §

    type Target = [u8]

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &[u8] ⓘ

    Dereferences the value.
    source§

    impl Display for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'i, S> FindSlice<S> for &'i Bytes
    where - &'i [u8]: FindSlice<S>,

    source§

    fn find_slice(&self, substr: S) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<'a> From<&'a [u8]> for &'a Bytes

    source§

    fn from(s: &'a [u8]) -> &'a Bytes

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a Bytes> for &'a [u8]

    source§

    fn from(s: &'a Bytes) -> &'a [u8] ⓘ

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a str> for &'a Bytes

    source§

    fn from(s: &'a str) -> &'a Bytes

    Converts to this type from the input type.
    source§

    impl Hash for Bytes

    source§

    fn hash<__H: Hasher>(&self, state: &mut __H)

    Feeds this value into the given Hasher. Read more
    source§

    impl Index<Range<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: Range<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFrom<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeFrom<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFull> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, _: RangeFull) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeInclusive<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeInclusive<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeTo<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeTo<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeToInclusive<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeToInclusive<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<usize> for Bytes

    §

    type Output = u8

    The returned type after indexing.
    source§

    fn index(&self, idx: usize) -> &u8

    Performs the indexing (container[index]) operation. Read more
    source§

    impl LowerHex for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter.
    source§

    impl<'a> Offset<<&'a Bytes as Stream>::Checkpoint> for &'a Bytes

    source§

    fn offset_from(&self, other: &<&'a Bytes as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<'a> Offset for &'a Bytes

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl Ord for Bytes

    source§

    fn cmp(&self, other: &Bytes) -> Ordering

    This method returns an Ordering between self and other. Read more
    source§

    impl<'a, 'b> PartialEq<&'a [u8]> for Bytes

    source§

    fn eq(&self, other: &&'a [u8]) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<&'a str> for Bytes

    source§

    fn eq(&self, other: &&'a str) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<[u8]> for Bytes

    source§

    fn eq(&self, other: &[u8]) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<Bytes> for &'a [u8]

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<Bytes> for &'a str

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<Bytes> for [u8]

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<Bytes> for str

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used +

    Trait Implementations§

    source§

    impl<'a> AsBytes for &'a Bytes

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl AsRef<[u8]> for Bytes

    source§

    fn as_ref(&self) -> &[u8] ⓘ

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<Bytes> for [u8]

    source§

    fn as_ref(&self) -> &Bytes

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl AsRef<Bytes> for str

    source§

    fn as_ref(&self) -> &Bytes

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl Borrow<Bytes> for Vec<u8>

    source§

    fn borrow(&self) -> &Bytes

    Immutably borrows from an owned value. Read more
    source§

    impl<'a, T> Compare<T> for &'a Bytes
    where + &'a [u8]: Compare<T>,

    source§

    fn compare(&self, t: T) -> CompareResult

    Compares self to another value for equality
    source§

    impl Debug for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'a> Default for &'a Bytes

    source§

    fn default() -> &'a Bytes

    Returns the “default value” for a type. Read more
    source§

    impl Deref for Bytes

    §

    type Target = [u8]

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &[u8] ⓘ

    Dereferences the value.
    source§

    impl Display for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<'i, S> FindSlice<S> for &'i Bytes
    where + &'i [u8]: FindSlice<S>,

    source§

    fn find_slice(&self, substr: S) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<'a> From<&'a [u8]> for &'a Bytes

    source§

    fn from(s: &'a [u8]) -> &'a Bytes

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a Bytes> for &'a [u8]

    source§

    fn from(s: &'a Bytes) -> &'a [u8] ⓘ

    Converts to this type from the input type.
    source§

    impl<'a> From<&'a str> for &'a Bytes

    source§

    fn from(s: &'a str) -> &'a Bytes

    Converts to this type from the input type.
    source§

    impl Hash for Bytes

    source§

    fn hash<__H: Hasher>(&self, state: &mut __H)

    Feeds this value into the given Hasher. Read more
    source§

    impl Index<Range<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: Range<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFrom<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeFrom<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeFull> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, _: RangeFull) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeInclusive<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeInclusive<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeTo<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeTo<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<RangeToInclusive<usize>> for Bytes

    §

    type Output = Bytes

    The returned type after indexing.
    source§

    fn index(&self, r: RangeToInclusive<usize>) -> &Bytes

    Performs the indexing (container[index]) operation. Read more
    source§

    impl Index<usize> for Bytes

    §

    type Output = u8

    The returned type after indexing.
    source§

    fn index(&self, idx: usize) -> &u8

    Performs the indexing (container[index]) operation. Read more
    source§

    impl LowerHex for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter.
    source§

    impl<'a> Offset<<&'a Bytes as Stream>::Checkpoint> for &'a Bytes

    source§

    fn offset_from(&self, other: &<&'a Bytes as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<'a> Offset for &'a Bytes

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl Ord for Bytes

    source§

    fn cmp(&self, other: &Bytes) -> Ordering

    This method returns an Ordering between self and other. Read more
    source§

    impl<'a> PartialEq<&'a [u8]> for Bytes

    source§

    fn eq(&self, other: &&'a [u8]) -> bool

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialEq<str> for Bytes

    source§

    fn eq(&self, other: &str) -> bool

    This method tests for self and other values to be equal, and is used -by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl PartialEq for Bytes

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<&'a str> for Bytes

    source§

    fn eq(&self, other: &&'a str) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<[u8]> for Bytes

    source§

    fn eq(&self, other: &[u8]) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<Bytes> for &'a [u8]

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<Bytes> for &'a str

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<'a, 'b> PartialOrd<&'a [u8]> for Bytes

    source§

    fn partial_cmp(&self, other: &&'a [u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<&'a str> for Bytes

    source§

    fn partial_cmp(&self, other: &&'a str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<[u8]> for Bytes

    source§

    fn partial_cmp(&self, other: &[u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<Bytes> for &'a [u8]

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<Bytes> for &'a str

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<Bytes> for [u8]

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<Bytes> for [u8]

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<Bytes> for str

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialEq<str> for Bytes

    source§

    fn eq(&self, other: &str) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl PartialEq for Bytes

    source§

    fn eq(&self, other: &Bytes) -> bool

    This method tests for self and other values to be equal, and is used +by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always +sufficient, and should not be overridden without very good reason.
    source§

    impl<'a> PartialOrd<&'a [u8]> for Bytes

    source§

    fn partial_cmp(&self, other: &&'a [u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<Bytes> for str

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= -operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a, 'b> PartialOrd<str> for Bytes

    source§

    fn partial_cmp(&self, other: &str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    source§

    impl<'a> PartialOrd<&'a str> for Bytes

    source§

    fn partial_cmp(&self, other: &&'a str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<[u8]> for Bytes

    source§

    fn partial_cmp(&self, other: &[u8]) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl PartialOrd for Bytes

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    source§

    impl<'a> PartialOrd<Bytes> for &'a [u8]

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<Bytes> for &'a str

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<Bytes> for [u8]

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<'a> SliceLen for &'a Bytes

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, -and the name of the trait itself
    source§

    impl<'i> Stream for &'i Bytes

    §

    type Token = u8

    The smallest unit being parsed Read more
    §

    type Slice = &'i [u8]

    Sequence of Tokens Read more
    §

    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<&'i Bytes, &'i Bytes>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where - P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn peek_token(&self) -> Option<(Self, Self::Token)>
    where - Self: Clone,

    Split off the next token from the input
    source§

    fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
    where - Self: Clone,

    Split off a slice of tokens from the input
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    fn peek_finish(&self) -> (Self, Self::Slice)
    where - Self: Clone,

    Advance to the end of the stream
    source§

    impl<'a> StreamIsPartial for &'a Bytes

    §

    type PartialState = ()

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, _state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl ToOwned for Bytes

    §

    type Owned = Vec<u8>

    The resulting type after obtaining ownership.
    source§

    fn to_owned(&self) -> Self::Owned

    Creates owned data from borrowed data, usually by cloning. Read more
    1.63.0 · source§

    fn clone_into(&self, target: &mut Self::Owned)

    Uses borrowed data to replace owned data, usually by cloning. Read more
    source§

    impl<'a> UpdateSlice for &'a Bytes

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl UpperHex for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter.
    source§

    impl Eq for Bytes

    Auto Trait Implementations§

    §

    impl Freeze for Bytes

    §

    impl RefUnwindSafe for Bytes

    §

    impl Send for Bytes

    §

    impl !Sized for Bytes

    §

    impl Sync for Bytes

    §

    impl Unpin for Bytes

    §

    impl UnwindSafe for Bytes

    Blanket Implementations§

    source§

    impl<T> Any for T
    where +operator. Read more

    source§

    impl<'a> PartialOrd<Bytes> for str

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> PartialOrd<str> for Bytes

    source§

    fn partial_cmp(&self, other: &str) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl PartialOrd for Bytes

    source§

    fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= +operator. Read more
    source§

    impl<'a> SliceLen for &'a Bytes

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, +and the name of the trait itself
    source§

    impl<'i> Stream for &'i Bytes

    §

    type Token = u8

    The smallest unit being parsed Read more
    §

    type Slice = &'i [u8]

    Sequence of Tokens Read more
    §

    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<&'i Bytes, &'i Bytes>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn peek_token(&self) -> Option<(Self, Self::Token)>
    where + Self: Clone,

    Split off the next token from the input
    source§

    fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
    where + Self: Clone,

    Split off a slice of tokens from the input
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    fn peek_finish(&self) -> (Self, Self::Slice)
    where + Self: Clone,

    Advance to the end of the stream
    source§

    impl<'a> StreamIsPartial for &'a Bytes

    §

    type PartialState = ()

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, _state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl ToOwned for Bytes

    §

    type Owned = Vec<u8>

    The resulting type after obtaining ownership.
    source§

    fn to_owned(&self) -> Self::Owned

    Creates owned data from borrowed data, usually by cloning. Read more
    1.63.0 · source§

    fn clone_into(&self, target: &mut Self::Owned)

    Uses borrowed data to replace owned data, usually by cloning. Read more
    source§

    impl<'a> UpdateSlice for &'a Bytes

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl UpperHex for Bytes

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter.
    source§

    impl Eq for Bytes

    Auto Trait Implementations§

    §

    impl Freeze for Bytes

    §

    impl RefUnwindSafe for Bytes

    §

    impl Send for Bytes

    §

    impl !Sized for Bytes

    §

    impl Sync for Bytes

    §

    impl Unpin for Bytes

    §

    impl UnwindSafe for Bytes

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    source§

    impl<T> ToString for T
    where - T: Display + ?Sized,

    source§

    default fn to_string(&self) -> String

    Converts the given value to a String. Read more
    \ No newline at end of file + T: Display + ?Sized,
    source§

    default fn to_string(&self) -> String

    Converts the given value to a String. Read more
    \ No newline at end of file diff --git a/winnow/stream/struct.Checkpoint.html b/winnow/stream/struct.Checkpoint.html index 8fbe643bf..72ed80251 100644 --- a/winnow/stream/struct.Checkpoint.html +++ b/winnow/stream/struct.Checkpoint.html @@ -1,7 +1,7 @@ -Checkpoint in winnow::stream - Rust
    -

    Struct winnow::stream::Checkpoint

    source · 
    pub struct Checkpoint<T, S> { /* private fields */ }
    Expand description

    Ensure checkpoint details are kept private

    -

    Trait Implementations§

    source§

    impl<T: Clone, S> Clone for Checkpoint<T, S>

    source§

    fn clone(&self) -> Self

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<T: Debug, S> Debug for Checkpoint<T, S>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, S> Offset for Checkpoint<I, S>
    where - I: Offset,

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<T: Copy, S> Copy for Checkpoint<T, S>

    Auto Trait Implementations§

    §

    impl<T, S> Freeze for Checkpoint<T, S>
    where +Checkpoint in winnow::stream - Rust
    +

    Struct winnow::stream::Checkpoint

    source · 
    pub struct Checkpoint<T, S> { /* private fields */ }
    Expand description

    Ensure checkpoint details are kept private

    +

    Trait Implementations§

    source§

    impl<T: Clone, S> Clone for Checkpoint<T, S>

    source§

    fn clone(&self) -> Self

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<T: Debug, S> Debug for Checkpoint<T, S>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, S> Offset for Checkpoint<I, S>
    where + I: Offset,

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<T: Copy, S> Copy for Checkpoint<T, S>

    Auto Trait Implementations§

    §

    impl<T, S> Freeze for Checkpoint<T, S>
    where T: Freeze,

    §

    impl<T, S> RefUnwindSafe for Checkpoint<T, S>
    where S: RefUnwindSafe, T: RefUnwindSafe,

    §

    impl<T, S> Send for Checkpoint<T, S>
    where diff --git a/winnow/stream/struct.Located.html b/winnow/stream/struct.Located.html index fd29879bf..3ebbdf3f5 100644 --- a/winnow/stream/struct.Located.html +++ b/winnow/stream/struct.Located.html @@ -1,5 +1,5 @@ -Located in winnow::stream - Rust
    -

    Struct winnow::stream::Located

    source · 
    pub struct Located<I> { /* private fields */ }
    Expand description

    Allow collecting the span of a parsed token

    +Located in winnow::stream - Rust
    +

    Struct winnow::stream::Located

    source · 
    pub struct Located<I> { /* private fields */ }
    Expand description

    Allow collecting the span of a parsed token

    Spans are tracked as a Range<usize> of byte offsets.

    Converting byte offsets to line or column numbers is left up to the user, as computing column numbers requires domain knowledge (are columns byte-based, codepoint-based, or grapheme-based?) @@ -7,28 +7,28 @@ and O(n) iteration over the input to determine codepoint and line boundaries.

    The line-span crate can help with converting byte offsets to line numbers.

    See Parser::span and Parser::with_span for more details

    -

    Implementations§

    source§

    impl<I> Located<I>
    where - I: Clone + Offset,

    source

    pub fn new(input: I) -> Self

    Wrap another Stream with span tracking

    -

    Trait Implementations§

    source§

    impl<I> AsBStr for Located<I>
    where - I: AsBStr,

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I> AsBytes for Located<I>
    where - I: AsBytes,

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I> AsRef<I> for Located<I>

    source§

    fn as_ref(&self) -> &I

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl<I: Clone> Clone for Located<I>

    source§

    fn clone(&self) -> Located<I>

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<I, U> Compare<U> for Located<I>
    where - I: Compare<U>,

    source§

    fn compare(&self, other: U) -> CompareResult

    Compares self to another value for equality
    source§

    impl<I: Debug> Debug for Located<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I: Default> Default for Located<I>

    source§

    fn default() -> Located<I>

    Returns the “default value” for a type. Read more
    source§

    impl<I> Deref for Located<I>

    §

    type Target = I

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &Self::Target

    Dereferences the value.
    source§

    impl<I: Display> Display for Located<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, T> FindSlice<T> for Located<I>
    where - I: FindSlice<T>,

    source§

    fn find_slice(&self, substr: T) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<I> Location for Located<I>
    where - I: Clone + Offset,

    source§

    fn location(&self) -> usize

    Number of indices input has advanced since start of parsing
    source§

    impl<I> Offset<<Located<I> as Stream>::Checkpoint> for Located<I>
    where - I: Stream,

    source§

    fn offset_from(&self, other: &<Located<I> as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I> Offset for Located<I>
    where - I: Stream,

    source§

    fn offset_from(&self, other: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I: Ord> Ord for Located<I>

    source§

    fn cmp(&self, other: &Located<I>) -> Ordering

    This method returns an Ordering between self and other. Read more
    1.21.0 · source§

    fn max(self, other: Self) -> Self
    where +

    Implementations§

    source§

    impl<I> Located<I>
    where + I: Clone + Offset,

    source

    pub fn new(input: I) -> Self

    Wrap another Stream with span tracking

    +

    Trait Implementations§

    source§

    impl<I> AsBStr for Located<I>
    where + I: AsBStr,

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I> AsBytes for Located<I>
    where + I: AsBytes,

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I> AsRef<I> for Located<I>

    source§

    fn as_ref(&self) -> &I

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl<I: Clone> Clone for Located<I>

    source§

    fn clone(&self) -> Located<I>

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<I, U> Compare<U> for Located<I>
    where + I: Compare<U>,

    source§

    fn compare(&self, other: U) -> CompareResult

    Compares self to another value for equality
    source§

    impl<I: Debug> Debug for Located<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I: Default> Default for Located<I>

    source§

    fn default() -> Located<I>

    Returns the “default value” for a type. Read more
    source§

    impl<I> Deref for Located<I>

    §

    type Target = I

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &Self::Target

    Dereferences the value.
    source§

    impl<I: Display> Display for Located<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, T> FindSlice<T> for Located<I>
    where + I: FindSlice<T>,

    source§

    fn find_slice(&self, substr: T) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<I> Location for Located<I>
    where + I: Clone + Offset,

    source§

    fn location(&self) -> usize

    Number of indices input has advanced since start of parsing
    source§

    impl<I> Offset<<Located<I> as Stream>::Checkpoint> for Located<I>
    where + I: Stream,

    source§

    fn offset_from(&self, other: &<Located<I> as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I> Offset for Located<I>
    where + I: Stream,

    source§

    fn offset_from(&self, other: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I: Ord> Ord for Located<I>

    source§

    fn cmp(&self, other: &Located<I>) -> Ordering

    This method returns an Ordering between self and other. Read more
    1.21.0 · source§

    fn max(self, other: Self) -> Self
    where Self: Sized,

    Compares and returns the maximum of two values. Read more
    1.21.0 · source§

    fn min(self, other: Self) -> Self
    where Self: Sized,

    Compares and returns the minimum of two values. Read more
    1.50.0 · source§

    fn clamp(self, min: Self, max: Self) -> Self
    where - Self: Sized + PartialOrd,

    Restrict a value to a certain interval. Read more
    source§

    impl<I: PartialEq> PartialEq for Located<I>

    source§

    fn eq(&self, other: &Located<I>) -> bool

    This method tests for self and other values to be equal, and is used + Self: Sized + PartialOrd,

    Restrict a value to a certain interval. Read more
    source§

    impl<I: PartialEq> PartialEq for Located<I>

    source§

    fn eq(&self, other: &Located<I>) -> bool

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<I: PartialOrd> PartialOrd for Located<I>

    source§

    fn partial_cmp(&self, other: &Located<I>) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +sufficient, and should not be overridden without very good reason.
    source§

    impl<I: PartialOrd> PartialOrd for Located<I>

    source§

    fn partial_cmp(&self, other: &Located<I>) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<I> SliceLen for Located<I>
    where - I: SliceLen,

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, -and the name of the trait itself
    source§

    impl<I: Stream> Stream for Located<I>

    §

    type Token = <I as Stream>::Token

    The smallest unit being parsed Read more
    §

    type Slice = <I as Stream>::Slice

    Sequence of Tokens Read more
    §

    type IterOffsets = <I as Stream>::IterOffsets

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Located<I>>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where - P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    impl<I> StreamIsPartial for Located<I>
    where - I: StreamIsPartial,

    §

    type PartialState = <I as StreamIsPartial>::PartialState

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl<I> UpdateSlice for Located<I>
    where - I: UpdateSlice,

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl<I: Copy> Copy for Located<I>

    source§

    impl<I: Eq> Eq for Located<I>

    source§

    impl<I> StructuralPartialEq for Located<I>

    Auto Trait Implementations§

    §

    impl<I> Freeze for Located<I>
    where +operator. Read more

    source§

    impl<I> SliceLen for Located<I>
    where + I: SliceLen,

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, +and the name of the trait itself
    source§

    impl<I: Stream> Stream for Located<I>

    §

    type Token = <I as Stream>::Token

    The smallest unit being parsed Read more
    §

    type Slice = <I as Stream>::Slice

    Sequence of Tokens Read more
    §

    type IterOffsets = <I as Stream>::IterOffsets

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Located<I>>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    impl<I> StreamIsPartial for Located<I>
    where + I: StreamIsPartial,

    §

    type PartialState = <I as StreamIsPartial>::PartialState

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl<I> UpdateSlice for Located<I>
    where + I: UpdateSlice,

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl<I: Copy> Copy for Located<I>

    source§

    impl<I: Eq> Eq for Located<I>

    source§

    impl<I> StructuralPartialEq for Located<I>

    Auto Trait Implementations§

    §

    impl<I> Freeze for Located<I>
    where I: Freeze,

    §

    impl<I> RefUnwindSafe for Located<I>
    where I: RefUnwindSafe,

    §

    impl<I> Send for Located<I>
    where I: Send,

    §

    impl<I> Sync for Located<I>
    where diff --git a/winnow/stream/struct.Partial.html b/winnow/stream/struct.Partial.html index 921527224..d76e2385f 100644 --- a/winnow/stream/struct.Partial.html +++ b/winnow/stream/struct.Partial.html @@ -1,5 +1,5 @@ -Partial in winnow::stream - Rust
    -

    Struct winnow::stream::Partial

    source · 
    pub struct Partial<I> { /* private fields */ }
    Expand description

    Mark the input as a partial buffer for streaming input.

    +Partial in winnow::stream - Rust
    +

    Struct winnow::stream::Partial

    source · 
    pub struct Partial<I> { /* private fields */ }
    Expand description

    Mark the input as a partial buffer for streaming input.

    Complete input means that we already have all of the data. This will be the common case with small files that can be read entirely to memory.

    In contrast, streaming input assumes that we might not have all of the data. @@ -55,30 +55,30 @@ input buffer can be full and need to be resized or refilled.

    // while the complete version knows that all of the data is there assert_eq!(alpha0_complete.parse_peek("abcd"), Ok(("", "abcd")));
    -

    Implementations§

    source§

    impl<I> Partial<I>
    where - I: StreamIsPartial,

    source

    pub fn new(input: I) -> Self

    Create a partial input

    -
    source

    pub fn into_inner(self) -> I

    Extract the original Stream

    -

    Trait Implementations§

    source§

    impl<I> AsBStr for Partial<I>
    where - I: AsBStr,

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I> AsBytes for Partial<I>
    where - I: AsBytes,

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I: Clone> Clone for Partial<I>

    source§

    fn clone(&self) -> Partial<I>

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<I, T> Compare<T> for Partial<I>
    where - I: Compare<T>,

    source§

    fn compare(&self, t: T) -> CompareResult

    Compares self to another value for equality
    source§

    impl<I: Debug> Debug for Partial<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I> Default for Partial<I>
    where - I: Default + StreamIsPartial,

    source§

    fn default() -> Self

    Returns the “default value” for a type. Read more
    source§

    impl<I> Deref for Partial<I>

    §

    type Target = I

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &Self::Target

    Dereferences the value.
    source§

    impl<I: Display> Display for Partial<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, T> FindSlice<T> for Partial<I>
    where - I: FindSlice<T>,

    source§

    fn find_slice(&self, substr: T) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<I> Location for Partial<I>
    where - I: Location,

    source§

    fn location(&self) -> usize

    Number of indices input has advanced since start of parsing
    source§

    impl<I> Offset<<Partial<I> as Stream>::Checkpoint> for Partial<I>
    where - I: Stream,

    source§

    fn offset_from(&self, other: &<Partial<I> as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I> Offset for Partial<I>
    where - I: Stream,

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I: Ord> Ord for Partial<I>

    source§

    fn cmp(&self, other: &Partial<I>) -> Ordering

    This method returns an Ordering between self and other. Read more
    1.21.0 · source§

    fn max(self, other: Self) -> Self
    where +

    Implementations§

    source§

    impl<I> Partial<I>
    where + I: StreamIsPartial,

    source

    pub fn new(input: I) -> Self

    Create a partial input

    +
    source

    pub fn into_inner(self) -> I

    Extract the original Stream

    +

    Trait Implementations§

    source§

    impl<I> AsBStr for Partial<I>
    where + I: AsBStr,

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I> AsBytes for Partial<I>
    where + I: AsBytes,

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I: Clone> Clone for Partial<I>

    source§

    fn clone(&self) -> Partial<I>

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<I, T> Compare<T> for Partial<I>
    where + I: Compare<T>,

    source§

    fn compare(&self, t: T) -> CompareResult

    Compares self to another value for equality
    source§

    impl<I: Debug> Debug for Partial<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I> Default for Partial<I>
    where + I: Default + StreamIsPartial,

    source§

    fn default() -> Self

    Returns the “default value” for a type. Read more
    source§

    impl<I> Deref for Partial<I>

    §

    type Target = I

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &Self::Target

    Dereferences the value.
    source§

    impl<I: Display> Display for Partial<I>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, T> FindSlice<T> for Partial<I>
    where + I: FindSlice<T>,

    source§

    fn find_slice(&self, substr: T) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<I> Location for Partial<I>
    where + I: Location,

    source§

    fn location(&self) -> usize

    Number of indices input has advanced since start of parsing
    source§

    impl<I> Offset<<Partial<I> as Stream>::Checkpoint> for Partial<I>
    where + I: Stream,

    source§

    fn offset_from(&self, other: &<Partial<I> as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I> Offset for Partial<I>
    where + I: Stream,

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I: Ord> Ord for Partial<I>

    source§

    fn cmp(&self, other: &Partial<I>) -> Ordering

    This method returns an Ordering between self and other. Read more
    1.21.0 · source§

    fn max(self, other: Self) -> Self
    where Self: Sized,

    Compares and returns the maximum of two values. Read more
    1.21.0 · source§

    fn min(self, other: Self) -> Self
    where Self: Sized,

    Compares and returns the minimum of two values. Read more
    1.50.0 · source§

    fn clamp(self, min: Self, max: Self) -> Self
    where - Self: Sized + PartialOrd,

    Restrict a value to a certain interval. Read more
    source§

    impl<I: PartialEq> PartialEq for Partial<I>

    source§

    fn eq(&self, other: &Partial<I>) -> bool

    This method tests for self and other values to be equal, and is used + Self: Sized + PartialOrd,

    Restrict a value to a certain interval. Read more
    source§

    impl<I: PartialEq> PartialEq for Partial<I>

    source§

    fn eq(&self, other: &Partial<I>) -> bool

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<I: PartialOrd> PartialOrd for Partial<I>

    source§

    fn partial_cmp(&self, other: &Partial<I>) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= +sufficient, and should not be overridden without very good reason.
    source§

    impl<I: PartialOrd> PartialOrd for Partial<I>

    source§

    fn partial_cmp(&self, other: &Partial<I>) -> Option<Ordering>

    This method returns an ordering between self and other values if one exists. Read more
    1.0.0 · source§

    fn lt(&self, other: &Rhs) -> bool

    This method tests less than (for self and other) and is used by the < operator. Read more
    1.0.0 · source§

    fn le(&self, other: &Rhs) -> bool

    This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
    1.0.0 · source§

    fn gt(&self, other: &Rhs) -> bool

    This method tests greater than (for self and other) and is used by the > operator. Read more
    1.0.0 · source§

    fn ge(&self, other: &Rhs) -> bool

    This method tests greater than or equal to (for self and other) and is used by the >= -operator. Read more
    source§

    impl<I> SliceLen for Partial<I>
    where - I: SliceLen,

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, -and the name of the trait itself
    source§

    impl<I: Stream> Stream for Partial<I>

    §

    type Token = <I as Stream>::Token

    The smallest unit being parsed Read more
    §

    type Slice = <I as Stream>::Slice

    Sequence of Tokens Read more
    §

    type IterOffsets = <I as Stream>::IterOffsets

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Partial<I>>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where - P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    impl<I> StreamIsPartial for Partial<I>
    where - I: StreamIsPartial,

    §

    type PartialState = bool

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl<I> UpdateSlice for Partial<I>
    where - I: UpdateSlice,

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl<I: Copy> Copy for Partial<I>

    source§

    impl<I: Eq> Eq for Partial<I>

    source§

    impl<I> StructuralPartialEq for Partial<I>

    Auto Trait Implementations§

    §

    impl<I> Freeze for Partial<I>
    where +operator. Read more

    source§

    impl<I> SliceLen for Partial<I>
    where + I: SliceLen,

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, +and the name of the trait itself
    source§

    impl<I: Stream> Stream for Partial<I>

    §

    type Token = <I as Stream>::Token

    The smallest unit being parsed Read more
    §

    type Slice = <I as Stream>::Slice

    Sequence of Tokens Read more
    §

    type IterOffsets = <I as Stream>::IterOffsets

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Partial<I>>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    impl<I> StreamIsPartial for Partial<I>
    where + I: StreamIsPartial,

    §

    type PartialState = bool

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl<I> UpdateSlice for Partial<I>
    where + I: UpdateSlice,

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl<I: Copy> Copy for Partial<I>

    source§

    impl<I: Eq> Eq for Partial<I>

    source§

    impl<I> StructuralPartialEq for Partial<I>

    Auto Trait Implementations§

    §

    impl<I> Freeze for Partial<I>
    where I: Freeze,

    §

    impl<I> RefUnwindSafe for Partial<I>
    where I: RefUnwindSafe,

    §

    impl<I> Send for Partial<I>
    where I: Send,

    §

    impl<I> Sync for Partial<I>
    where diff --git a/winnow/stream/struct.Range.html b/winnow/stream/struct.Range.html index bd47cbf70..316889f30 100644 --- a/winnow/stream/struct.Range.html +++ b/winnow/stream/struct.Range.html @@ -1,5 +1,5 @@ -Range in winnow::stream - Rust
    -

    Struct winnow::stream::Range

    source · 
    pub struct Range { /* private fields */ }
    Expand description

    A range bounded inclusively for counting parses performed

    +Range in winnow::stream - Rust
    +

    Struct winnow::stream::Range

    source · 
    pub struct Range { /* private fields */ }
    Expand description

    A range bounded inclusively for counting parses performed

    This is flexible in what can be converted to a Range:

    let parser: Vec<_> = repeat(5, inner).parse_next(input).unwrap();
@@ -7,11 +7,11 @@
 let parser: Vec<_> = repeat(1.., inner).parse_next(input).unwrap();
 let parser: Vec<_> = repeat(5..8, inner).parse_next(input).unwrap();
 let parser: Vec<_> = repeat(5..=8, inner).parse_next(input).unwrap();
    -

    Trait Implementations§

    source§

    impl Debug for Range

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl Display for Range

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl From<Range<usize>> for Range

    source§

    fn from(range: Range<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeFrom<usize>> for Range

    source§

    fn from(range: RangeFrom<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeFull> for Range

    source§

    fn from(_: RangeFull) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeInclusive<usize>> for Range

    source§

    fn from(range: RangeInclusive<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeTo<usize>> for Range

    source§

    fn from(range: RangeTo<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeToInclusive<usize>> for Range

    source§

    fn from(range: RangeToInclusive<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<usize> for Range

    source§

    fn from(fixed: usize) -> Self

    Converts to this type from the input type.
    source§

    impl PartialEq for Range

    source§

    fn eq(&self, other: &Range) -> bool

    This method tests for self and other values to be equal, and is used +

    Trait Implementations§

    source§

    impl Debug for Range

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl Display for Range

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl From<Range<usize>> for Range

    source§

    fn from(range: Range<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeFrom<usize>> for Range

    source§

    fn from(range: RangeFrom<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeFull> for Range

    source§

    fn from(_: RangeFull) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeInclusive<usize>> for Range

    source§

    fn from(range: RangeInclusive<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeTo<usize>> for Range

    source§

    fn from(range: RangeTo<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<RangeToInclusive<usize>> for Range

    source§

    fn from(range: RangeToInclusive<usize>) -> Self

    Converts to this type from the input type.
    source§

    impl From<usize> for Range

    source§

    fn from(fixed: usize) -> Self

    Converts to this type from the input type.
    source§

    impl PartialEq for Range

    source§

    fn eq(&self, other: &Range) -> bool

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl RangeBounds<usize> for Range

    source§

    fn start_bound(&self) -> Bound<&usize>

    Start index bound. Read more
    source§

    fn end_bound(&self) -> Bound<&usize>

    End index bound. Read more
    1.35.0 · source§

    fn contains<U>(&self, item: &U) -> bool
    where +sufficient, and should not be overridden without very good reason.

    source§

    impl RangeBounds<usize> for Range

    source§

    fn start_bound(&self) -> Bound<&usize>

    Start index bound. Read more
    source§

    fn end_bound(&self) -> Bound<&usize>

    End index bound. Read more
    1.35.0 · source§

    fn contains<U>(&self, item: &U) -> bool
    where T: PartialOrd<U>, - U: PartialOrd<T> + ?Sized,

    Returns true if item is contained in the range. Read more
    source§

    impl Eq for Range

    source§

    impl StructuralPartialEq for Range

    Auto Trait Implementations§

    §

    impl Freeze for Range

    §

    impl RefUnwindSafe for Range

    §

    impl Send for Range

    §

    impl Sync for Range

    §

    impl Unpin for Range

    §

    impl UnwindSafe for Range

    Blanket Implementations§

    source§

    impl<T> Any for T
    where + U: PartialOrd<T> + ?Sized,

    Returns true if item is contained in the range. Read more
    source§

    impl Eq for Range

    source§

    impl StructuralPartialEq for Range

    Auto Trait Implementations§

    §

    impl Freeze for Range

    §

    impl RefUnwindSafe for Range

    §

    impl Send for Range

    §

    impl Sync for Range

    §

    impl Unpin for Range

    §

    impl UnwindSafe for Range

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    source§

    impl<T> From<T> for T

    source§

    fn from(t: T) -> T

    Returns the argument unchanged.

    diff --git a/winnow/stream/struct.Stateful.html b/winnow/stream/struct.Stateful.html index dad2ffbda..d9646d2d0 100644 --- a/winnow/stream/struct.Stateful.html +++ b/winnow/stream/struct.Stateful.html @@ -1,5 +1,5 @@ -Stateful in winnow::stream - Rust
    -

    Struct winnow::stream::Stateful

    source · 
    pub struct Stateful<I, S> {
+Stateful in winnow::stream - Rust
    
+    
    Struct winnow::stream::Stateful
    source · 
    pub struct Stateful<I, S> {
     pub input: I,
     pub state: S,
 }
    Expand description
    Thread global state through your parsers
    
@@ -34,24 +34,24 @@
 assert_eq!(state.get(), 1);

    Fields§

    §input: I

    Inner input being wrapped in state

    §state: S

    User-provided state

    -

    Trait Implementations§

    source§

    impl<I, S> AsBStr for Stateful<I, S>
    where - I: AsBStr,

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I, S> AsBytes for Stateful<I, S>
    where - I: AsBytes,

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I, S> AsRef<I> for Stateful<I, S>

    source§

    fn as_ref(&self) -> &I

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl<I: Clone, S: Clone> Clone for Stateful<I, S>

    source§

    fn clone(&self) -> Stateful<I, S>

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<I, S, U> Compare<U> for Stateful<I, S>
    where - I: Compare<U>,

    source§

    fn compare(&self, other: U) -> CompareResult

    Compares self to another value for equality
    source§

    impl<I: Debug, S: Debug> Debug for Stateful<I, S>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, S> Deref for Stateful<I, S>

    §

    type Target = I

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &Self::Target

    Dereferences the value.
    source§

    impl<I: Display, S> Display for Stateful<I, S>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, S, T> FindSlice<T> for Stateful<I, S>
    where - I: FindSlice<T>,

    source§

    fn find_slice(&self, substr: T) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<I, S> Location for Stateful<I, S>
    where - I: Location,

    source§

    fn location(&self) -> usize

    Number of indices input has advanced since start of parsing
    source§

    impl<I, S> Offset<<Stateful<I, S> as Stream>::Checkpoint> for Stateful<I, S>
    where +

    Trait Implementations§

    source§

    impl<I, S> AsBStr for Stateful<I, S>
    where + I: AsBStr,

    source§

    fn as_bstr(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I, S> AsBytes for Stateful<I, S>
    where + I: AsBytes,

    source§

    fn as_bytes(&self) -> &[u8] ⓘ

    Casts the input type to a byte slice
    source§

    impl<I, S> AsRef<I> for Stateful<I, S>

    source§

    fn as_ref(&self) -> &I

    Converts this type into a shared reference of the (usually inferred) input type.
    source§

    impl<I: Clone, S: Clone> Clone for Stateful<I, S>

    source§

    fn clone(&self) -> Stateful<I, S>

    Returns a copy of the value. Read more
    1.0.0 · source§

    fn clone_from(&mut self, source: &Self)

    Performs copy-assignment from source. Read more
    source§

    impl<I, S, U> Compare<U> for Stateful<I, S>
    where + I: Compare<U>,

    source§

    fn compare(&self, other: U) -> CompareResult

    Compares self to another value for equality
    source§

    impl<I: Debug, S: Debug> Debug for Stateful<I, S>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, S> Deref for Stateful<I, S>

    §

    type Target = I

    The resulting type after dereferencing.
    source§

    fn deref(&self) -> &Self::Target

    Dereferences the value.
    source§

    impl<I: Display, S> Display for Stateful<I, S>

    source§

    fn fmt(&self, f: &mut Formatter<'_>) -> Result

    Formats the value using the given formatter. Read more
    source§

    impl<I, S, T> FindSlice<T> for Stateful<I, S>
    where + I: FindSlice<T>,

    source§

    fn find_slice(&self, substr: T) -> Option<Range<usize>>

    Returns the offset of the slice if it is found
    source§

    impl<I, S> Location for Stateful<I, S>
    where + I: Location,

    source§

    fn location(&self) -> usize

    Number of indices input has advanced since start of parsing
    source§

    impl<I, S> Offset<<Stateful<I, S> as Stream>::Checkpoint> for Stateful<I, S>
    where I: Stream, - S: Debug,

    source§

    fn offset_from(&self, other: &<Stateful<I, S> as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I, S> Offset for Stateful<I, S>
    where + S: Debug,

    source§

    fn offset_from(&self, other: &<Stateful<I, S> as Stream>::Checkpoint) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I, S> Offset for Stateful<I, S>
    where I: Stream, - S: Clone + Debug,

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I: PartialEq, S: PartialEq> PartialEq for Stateful<I, S>

    source§

    fn eq(&self, other: &Stateful<I, S>) -> bool

    This method tests for self and other values to be equal, and is used + S: Clone + Debug,

    source§

    fn offset_from(&self, start: &Self) -> usize

    Offset between the first byte of start and the first byte of selfa Read more
    source§

    impl<I: PartialEq, S: PartialEq> PartialEq for Stateful<I, S>

    source§

    fn eq(&self, other: &Stateful<I, S>) -> bool

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

    fn ne(&self, other: &Rhs) -> bool

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl<I, S> SliceLen for Stateful<I, S>
    where - I: SliceLen,

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, -and the name of the trait itself
    source§

    impl<I: Stream, S: Debug> Stream for Stateful<I, S>

    §

    type Token = <I as Stream>::Token

    The smallest unit being parsed Read more
    §

    type Slice = <I as Stream>::Slice

    Sequence of Tokens Read more
    §

    type IterOffsets = <I as Stream>::IterOffsets

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Stateful<I, S>>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where - P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    impl<I, S> StreamIsPartial for Stateful<I, S>
    where - I: StreamIsPartial,

    §

    type PartialState = <I as StreamIsPartial>::PartialState

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl<I, S> UpdateSlice for Stateful<I, S>
    where +sufficient, and should not be overridden without very good reason.

    source§

    impl<I, S> SliceLen for Stateful<I, S>
    where + I: SliceLen,

    source§

    fn slice_len(&self) -> usize

    Calculates the input length, as indicated by its name, +and the name of the trait itself
    source§

    impl<I: Stream, S: Debug> Stream for Stateful<I, S>

    §

    type Token = <I as Stream>::Token

    The smallest unit being parsed Read more
    §

    type Slice = <I as Stream>::Slice

    Sequence of Tokens Read more
    §

    type IterOffsets = <I as Stream>::IterOffsets

    Iterate with the offset from the current location
    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Stateful<I, S>>

    A parse location within the stream
    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    Iterate with the offset from the current location
    source§

    fn eof_offset(&self) -> usize

    Returns the offset to the end of the input
    source§

    fn next_token(&mut self) -> Option<Self::Token>

    Split off the next token from the input
    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    Finds the offset of the next matching token
    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    Get the offset for the number of tokens into the stream Read more
    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    Split off a slice of tokens from the input Read more
    source§

    fn checkpoint(&self) -> Self::Checkpoint

    Save the current parse location within the stream
    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    Revert the stream to a prior Self::Checkpoint Read more
    source§

    fn raw(&self) -> &dyn Debug

    Return the inner-most stream
    source§

    fn finish(&mut self) -> Self::Slice

    Advance to the end of the stream
    source§

    impl<I, S> StreamIsPartial for Stateful<I, S>
    where + I: StreamIsPartial,

    §

    type PartialState = <I as StreamIsPartial>::PartialState

    Whether the stream is currently partial or complete
    source§

    fn complete(&mut self) -> Self::PartialState

    Mark the stream is complete
    source§

    fn restore_partial(&mut self, state: Self::PartialState)

    Restore the stream back to its previous state
    source§

    fn is_partial_supported() -> bool

    Report whether the Stream is can ever be incomplete
    source§

    fn is_partial(&self) -> bool

    Report whether the Stream is currently incomplete
    source§

    impl<I, S> UpdateSlice for Stateful<I, S>
    where I: UpdateSlice, - S: Clone + Debug,

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl<I: Copy, S: Copy> Copy for Stateful<I, S>

    source§

    impl<I: Eq, S: Eq> Eq for Stateful<I, S>

    source§

    impl<I, S> StructuralPartialEq for Stateful<I, S>

    Auto Trait Implementations§

    §

    impl<I, S> Freeze for Stateful<I, S>
    where + S: Clone + Debug,

    source§

    fn update_slice(self, inner: Self::Slice) -> Self

    Convert an Output type to be used as Stream
    source§

    impl<I: Copy, S: Copy> Copy for Stateful<I, S>

    source§

    impl<I: Eq, S: Eq> Eq for Stateful<I, S>

    source§

    impl<I, S> StructuralPartialEq for Stateful<I, S>

    Auto Trait Implementations§

    §

    impl<I, S> Freeze for Stateful<I, S>
    where I: Freeze, S: Freeze,

    §

    impl<I, S> RefUnwindSafe for Stateful<I, S>
    where I: RefUnwindSafe, diff --git a/winnow/stream/trait.Accumulate.html b/winnow/stream/trait.Accumulate.html index 119fd1b2f..5c73b4cf3 100644 --- a/winnow/stream/trait.Accumulate.html +++ b/winnow/stream/trait.Accumulate.html @@ -1,16 +1,16 @@ -Accumulate in winnow::stream - Rust
    -

    Trait winnow::stream::Accumulate

    source · 
    pub trait Accumulate<T>: Sized {
+Accumulate in winnow::stream - Rust
    
+    
    Trait winnow::stream::Accumulate
    source · 
    pub trait Accumulate<T>: Sized {
     // Required methods
     fn initial(capacity: Option<usize>) -> Self;
     fn accumulate(&mut self, acc: T);
 }
    Expand description
    Abstracts something which can extend an Extend.
 Used to build modified input slices in escaped_transform
    
-
    Required Methods§
    source
    fn initial(capacity: Option<usize>) -> Self
    Create a new Extend of the correct type
    
-
    source
    fn accumulate(&mut self, acc: T)
    Accumulate the input into an accumulator
    
-
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl Accumulate<char> for String
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, acc: char)
    source§
    impl<'i> Accumulate<&'i str> for String
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, acc: &'i str)
    source§
    impl<'i, T: Clone> Accumulate<&'i [T]> for Vec<T>
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, acc: &'i [T])
    source§
    impl<K> Accumulate<K> for BTreeSet<K>
    where
-    K: Ord,
    source§
    fn initial(_capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, key: K)
    source§
    impl<K, S> Accumulate<K> for HashSet<K, S>
    where
+
    Required Methods§
    source
    fn initial(capacity: Option<usize>) -> Self
    Create a new Extend of the correct type
    
+
    source
    fn accumulate(&mut self, acc: T)
    Accumulate the input into an accumulator
    
+
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl Accumulate<char> for String
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, acc: char)
    source§
    impl<'i> Accumulate<&'i str> for String
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, acc: &'i str)
    source§
    impl<'i, T: Clone> Accumulate<&'i [T]> for Vec<T>
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, acc: &'i [T])
    source§
    impl<K> Accumulate<K> for BTreeSet<K>
    where
+    K: Ord,
    source§
    fn initial(_capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, key: K)
    source§
    impl<K, S> Accumulate<K> for HashSet<K, S>
    where
     K: Eq + Hash,
-    S: BuildHasher + Default,
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, key: K)
    source§
    impl<K, V> Accumulate<(K, V)> for BTreeMap<K, V>
    where
-    K: Ord,
    source§
    fn initial(_capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, (key, value): (K, V))
    source§
    impl<K, V, S> Accumulate<(K, V)> for HashMap<K, V, S>
    where
+    S: BuildHasher + Default,
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, key: K)
    source§
    impl<K, V> Accumulate<(K, V)> for BTreeMap<K, V>
    where
+    K: Ord,
    source§
    fn initial(_capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, (key, value): (K, V))
    source§
    impl<K, V, S> Accumulate<(K, V)> for HashMap<K, V, S>
    where
     K: Eq + Hash,
-    S: BuildHasher + Default,
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, (key, value): (K, V))
    source§
    impl<T> Accumulate<T> for ()
    source§
    fn initial(_capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, _acc: T)
    source§
    impl<T> Accumulate<T> for usize
    source§
    fn initial(_capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, _acc: T)
    source§
    impl<T> Accumulate<T> for Vec<T>
    source§
    fn initial(capacity: Option<usize>) -> Self
    source§
    fn accumulate(&mut self, acc: T)
    Implementors§
    
\ No newline at end of file
+    S: BuildHasher + Default,

    source§

    fn initial(capacity: Option<usize>) -> Self

    source§

    fn accumulate(&mut self, (key, value): (K, V))

    source§

    impl<T> Accumulate<T> for ()

    source§

    fn initial(_capacity: Option<usize>) -> Self

    source§

    fn accumulate(&mut self, _acc: T)

    source§

    impl<T> Accumulate<T> for usize

    source§

    fn initial(_capacity: Option<usize>) -> Self

    source§

    fn accumulate(&mut self, _acc: T)

    source§

    impl<T> Accumulate<T> for Vec<T>

    source§

    fn initial(capacity: Option<usize>) -> Self

    source§

    fn accumulate(&mut self, acc: T)

    Implementors§

    \ No newline at end of file diff --git a/winnow/stream/trait.AsBStr.html b/winnow/stream/trait.AsBStr.html index aad4783f1..b0c8aa5a5 100644 --- a/winnow/stream/trait.AsBStr.html +++ b/winnow/stream/trait.AsBStr.html @@ -1,10 +1,10 @@ -AsBStr in winnow::stream - Rust
    -

    Trait winnow::stream::AsBStr

    source · 
    pub trait AsBStr {
+AsBStr in winnow::stream - Rust
    
+    
    Trait winnow::stream::AsBStr
    source · 
    pub trait AsBStr {
     // Required method
     fn as_bstr(&self) -> &[u8] ⓘ;
 }
    Expand description
    Helper trait for types that can be viewed as a byte slice
    
-
    Required Methods§
    source
    fn as_bstr(&self) -> &[u8] ⓘ
    Casts the input type to a byte slice
    
-
    Implementations on Foreign Types§
    source§
    impl<'a> AsBStr for &'a str
    source§
    fn as_bstr(&self) -> &[u8] ⓘ
    source§
    impl<'a> AsBStr for &'a [u8]
    source§
    fn as_bstr(&self) -> &[u8] ⓘ
    Implementors§
    source§
    impl<'a> AsBStr for &'a BStr
    source§
    impl<I> AsBStr for Located<I>
    where
-    I: AsBStr,
    source§
    impl<I> AsBStr for Partial<I>
    where
-    I: AsBStr,
    source§
    impl<I, S> AsBStr for Stateful<I, S>
    where
+
    Required Methods§
    source
    fn as_bstr(&self) -> &[u8] ⓘ
    Casts the input type to a byte slice
    
+
    Implementations on Foreign Types§
    source§
    impl<'a> AsBStr for &'a str
    source§
    fn as_bstr(&self) -> &[u8] ⓘ
    source§
    impl<'a> AsBStr for &'a [u8]
    source§
    fn as_bstr(&self) -> &[u8] ⓘ
    Implementors§
    source§
    impl<'a> AsBStr for &'a BStr
    source§
    impl<I> AsBStr for Located<I>
    where
+    I: AsBStr,
    source§
    impl<I> AsBStr for Partial<I>
    where
+    I: AsBStr,
    source§
    impl<I, S> AsBStr for Stateful<I, S>
    where
     I: AsBStr,
    
\ No newline at end of file
diff --git a/winnow/stream/trait.AsBytes.html b/winnow/stream/trait.AsBytes.html
index 33dd5436d..78bf7de48 100644
--- a/winnow/stream/trait.AsBytes.html
+++ b/winnow/stream/trait.AsBytes.html
@@ -1,10 +1,10 @@
-AsBytes in winnow::stream - Rust
    
-    
    Trait winnow::stream::AsBytes
    source · 
    pub trait AsBytes {
+AsBytes in winnow::stream - Rust
    
+    
    Trait winnow::stream::AsBytes
    source · 
    pub trait AsBytes {
     // Required method
     fn as_bytes(&self) -> &[u8] ⓘ;
 }
    Expand description
    Helper trait for types that can be viewed as a byte slice
    
-
    Required Methods§
    source
    fn as_bytes(&self) -> &[u8] ⓘ
    Casts the input type to a byte slice
    
-
    Implementations on Foreign Types§
    source§
    impl<'a> AsBytes for &'a [u8]
    source§
    fn as_bytes(&self) -> &[u8] ⓘ
    Implementors§
    source§
    impl<'a> AsBytes for &'a Bytes
    source§
    impl<I> AsBytes for Located<I>
    where
-    I: AsBytes,
    source§
    impl<I> AsBytes for Partial<I>
    where
-    I: AsBytes,
    source§
    impl<I, S> AsBytes for Stateful<I, S>
    where
+
    Required Methods§
    source
    fn as_bytes(&self) -> &[u8] ⓘ
    Casts the input type to a byte slice
    
+
    Implementations on Foreign Types§
    source§
    impl<'a> AsBytes for &'a [u8]
    source§
    fn as_bytes(&self) -> &[u8] ⓘ
    Implementors§
    source§
    impl<'a> AsBytes for &'a Bytes
    source§
    impl<I> AsBytes for Located<I>
    where
+    I: AsBytes,
    source§
    impl<I> AsBytes for Partial<I>
    where
+    I: AsBytes,
    source§
    impl<I, S> AsBytes for Stateful<I, S>
    where
     I: AsBytes,
    
\ No newline at end of file
diff --git a/winnow/stream/trait.AsChar.html b/winnow/stream/trait.AsChar.html
index 16c810670..b5f3af0e5 100644
--- a/winnow/stream/trait.AsChar.html
+++ b/winnow/stream/trait.AsChar.html
@@ -1,5 +1,5 @@
-AsChar in winnow::stream - Rust
    
-    
    Trait winnow::stream::AsChar
    source · 
    pub trait AsChar {
+AsChar in winnow::stream - Rust
    
+    
    Trait winnow::stream::AsChar
    source · 
    pub trait AsChar {
     // Required methods
     fn as_char(self) -> char;
     fn is_alpha(self) -> bool;
@@ -11,21 +11,21 @@
     fn is_space(self) -> bool;
     fn is_newline(self) -> bool;
 }
    Expand description
    Transforms a token into a char for basic string parsing
    
-
    Required Methods§
    source
    fn as_char(self) -> char
    Makes a char from self
    
+
    Required Methods§
    source
    fn as_char(self) -> char
    Makes a char from self
    
 
    §Example
    
 
    use winnow::stream::AsChar as _;
 
 assert_eq!('a'.as_char(), 'a');
 assert_eq!(u8::MAX.as_char(), std::char::from_u32(u8::MAX as u32).unwrap());
    
-
    source
    fn is_alpha(self) -> bool
    Tests that self is an alphabetic character
    
+
    source
    fn is_alpha(self) -> bool
    Tests that self is an alphabetic character
    
 
    Warning: for &str it recognizes alphabetic
 characters outside of the 52 ASCII letters
    
-
    source
    fn is_alphanum(self) -> bool
    Tests that self is an alphabetic character
+
    source
    fn is_alphanum(self) -> bool
    Tests that self is an alphabetic character
 or a decimal digit
    
-
    source
    fn is_dec_digit(self) -> bool
    Tests that self is a decimal digit
    
-
    source
    fn is_hex_digit(self) -> bool
    Tests that self is an hex digit
    
-
    source
    fn is_oct_digit(self) -> bool
    Tests that self is an octal digit
    
-
    source
    fn len(self) -> usize
    Gets the len in bytes for self
    
-
    source
    fn is_space(self) -> bool
    Tests that self is ASCII space or tab
    
-
    source
    fn is_newline(self) -> bool
    Tests if byte is ASCII newline: \n
    
-
    Implementations on Foreign Types§
    source§
    impl AsChar for char
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    source§
    impl AsChar for u8
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    source§
    impl<'a> AsChar for &'a char
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    source§
    impl<'a> AsChar for &'a u8
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    Implementors§
    
\ No newline at end of file
+
    source
    fn is_dec_digit(self) -> bool
    Tests that self is a decimal digit
    
+
    source
    fn is_hex_digit(self) -> bool
    Tests that self is an hex digit
    
+
    source
    fn is_oct_digit(self) -> bool
    Tests that self is an octal digit
    
+
    source
    fn len(self) -> usize
    Gets the len in bytes for self
    
+
    source
    fn is_space(self) -> bool
    Tests that self is ASCII space or tab
    
+
    source
    fn is_newline(self) -> bool
    Tests if byte is ASCII newline: \n
    
+
    Implementations on Foreign Types§
    source§
    impl AsChar for char
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    source§
    impl AsChar for u8
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    source§
    impl<'a> AsChar for &'a char
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    source§
    impl<'a> AsChar for &'a u8
    source§
    fn as_char(self) -> char
    source§
    fn is_alpha(self) -> bool
    source§
    fn is_alphanum(self) -> bool
    source§
    fn is_dec_digit(self) -> bool
    source§
    fn is_hex_digit(self) -> bool
    source§
    fn is_oct_digit(self) -> bool
    source§
    fn len(self) -> usize
    source§
    fn is_space(self) -> bool
    source§
    fn is_newline(self) -> bool
    Implementors§
    \ No newline at end of file diff --git a/winnow/stream/trait.Compare.html b/winnow/stream/trait.Compare.html index e6223f6b5..55acb5108 100644 --- a/winnow/stream/trait.Compare.html +++ b/winnow/stream/trait.Compare.html @@ -1,12 +1,12 @@ -Compare in winnow::stream - Rust
    -

    Trait winnow::stream::Compare

    source · 
    pub trait Compare<T> {
+Compare in winnow::stream - Rust
    
+    
    Trait winnow::stream::Compare
    source · 
    pub trait Compare<T> {
     // Required method
     fn compare(&self, t: T) -> CompareResult;
 }
    Expand description
    Abstracts comparison operations
    
-
    Required Methods§
    source
    fn compare(&self, t: T) -> CompareResult
    Compares self to another value for equality
    
-
    Implementations on Foreign Types§
    source§
    impl<'a> Compare<char> for &'a str
    source§
    fn compare(&self, t: char) -> CompareResult
    source§
    impl<'a> Compare<char> for &'a [u8]
    source§
    fn compare(&self, t: char) -> CompareResult
    source§
    impl<'a> Compare<u8> for &'a [u8]
    source§
    fn compare(&self, t: u8) -> CompareResult
    source§
    impl<'a> Compare<Caseless<char>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    source§
    impl<'a> Compare<Caseless<char>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    source§
    impl<'a> Compare<Caseless<u8>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<u8>) -> CompareResult
    source§
    impl<'a, 'b> Compare<&'b str> for &'a str
    source§
    fn compare(&self, t: &'b str) -> CompareResult
    source§
    impl<'a, 'b> Compare<&'b str> for &'a [u8]
    source§
    fn compare(&self, t: &'b str) -> CompareResult
    source§
    impl<'a, 'b> Compare<&'b [u8]> for &'a [u8]
    source§
    fn compare(&self, t: &'b [u8]) -> CompareResult
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    source§
    impl<'a, 'b> Compare<Caseless<&'b [u8]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult
    source§
    impl<'a, 'b, const LEN: usize> Compare<&'b [u8; LEN]> for &'a [u8]
    source§
    fn compare(&self, t: &'b [u8; LEN]) -> CompareResult
    source§
    impl<'a, 'b, const LEN: usize> Compare<Caseless<&'b [u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8; LEN]>) -> CompareResult
    source§
    impl<'a, const LEN: usize> Compare<Caseless<[u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<[u8; LEN]>) -> CompareResult
    source§
    impl<'a, const LEN: usize> Compare<[u8; LEN]> for &'a [u8]
    source§
    fn compare(&self, t: [u8; LEN]) -> CompareResult
    Implementors§
    source§
    impl<'a, T> Compare<T> for &'a BStr
    where
-    &'a [u8]: Compare<T>,
    source§
    impl<'a, T> Compare<T> for &'a Bytes
    where
-    &'a [u8]: Compare<T>,
    source§
    impl<I, S, U> Compare<U> for Stateful<I, S>
    where
-    I: Compare<U>,
    source§
    impl<I, T> Compare<T> for Partial<I>
    where
-    I: Compare<T>,
    source§
    impl<I, U> Compare<U> for Located<I>
    where
+
    Required Methods§
    source
    fn compare(&self, t: T) -> CompareResult
    Compares self to another value for equality
    
+
    Implementations on Foreign Types§
    source§
    impl<'a> Compare<char> for &'a str
    source§
    fn compare(&self, t: char) -> CompareResult
    source§
    impl<'a> Compare<char> for &'a [u8]
    source§
    fn compare(&self, t: char) -> CompareResult
    source§
    impl<'a> Compare<u8> for &'a [u8]
    source§
    fn compare(&self, t: u8) -> CompareResult
    source§
    impl<'a> Compare<Caseless<char>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    source§
    impl<'a> Compare<Caseless<char>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<char>) -> CompareResult
    source§
    impl<'a> Compare<Caseless<u8>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<u8>) -> CompareResult
    source§
    impl<'a, 'b> Compare<&'b str> for &'a str
    source§
    fn compare(&self, t: &'b str) -> CompareResult
    source§
    impl<'a, 'b> Compare<&'b str> for &'a [u8]
    source§
    fn compare(&self, t: &'b str) -> CompareResult
    source§
    impl<'a, 'b> Compare<&'b [u8]> for &'a [u8]
    source§
    fn compare(&self, t: &'b [u8]) -> CompareResult
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a str
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    source§
    impl<'a, 'b> Compare<Caseless<&'b str>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult
    source§
    impl<'a, 'b> Compare<Caseless<&'b [u8]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult
    source§
    impl<'a, 'b, const LEN: usize> Compare<&'b [u8; LEN]> for &'a [u8]
    source§
    fn compare(&self, t: &'b [u8; LEN]) -> CompareResult
    source§
    impl<'a, 'b, const LEN: usize> Compare<Caseless<&'b [u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<&'b [u8; LEN]>) -> CompareResult
    source§
    impl<'a, const LEN: usize> Compare<Caseless<[u8; LEN]>> for &'a [u8]
    source§
    fn compare(&self, t: AsciiCaseless<[u8; LEN]>) -> CompareResult
    source§
    impl<'a, const LEN: usize> Compare<[u8; LEN]> for &'a [u8]
    source§
    fn compare(&self, t: [u8; LEN]) -> CompareResult
    Implementors§
    source§
    impl<'a, T> Compare<T> for &'a BStr
    where
+    &'a [u8]: Compare<T>,
    source§
    impl<'a, T> Compare<T> for &'a Bytes
    where
+    &'a [u8]: Compare<T>,
    source§
    impl<I, S, U> Compare<U> for Stateful<I, S>
    where
+    I: Compare<U>,
    source§
    impl<I, T> Compare<T> for Partial<I>
    where
+    I: Compare<T>,
    source§
    impl<I, U> Compare<U> for Located<I>
    where
     I: Compare<U>,
    
\ No newline at end of file
diff --git a/winnow/stream/trait.ContainsToken.html b/winnow/stream/trait.ContainsToken.html
index a32f0e548..f38b3212a 100644
--- a/winnow/stream/trait.ContainsToken.html
+++ b/winnow/stream/trait.ContainsToken.html
@@ -1,5 +1,5 @@
-ContainsToken in winnow::stream - Rust
    
-    
    Trait winnow::stream::ContainsToken
    source · 
    pub trait ContainsToken<T> {
+ContainsToken in winnow::stream - Rust
    
+    
    Trait winnow::stream::ContainsToken
    source · 
    pub trait ContainsToken<T> {
     // Required method
     fn contains_token(&self, token: T) -> bool;
 }
    Expand description
    Check if a token is in a set of possible tokens
    
@@ -21,35 +21,35 @@
 assert_eq!(hex_digit1.parse_peek("21cZ"), Ok(("Z", "21c")));
 assert_eq!(hex_digit1.parse_peek("H2"), Err(ErrMode::Backtrack(InputError::new("H2", ErrorKind::Slice))));
 assert_eq!(hex_digit1.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
    
-

    Required Methods§

    source

    fn contains_token(&self, token: T) -> bool

    Returns true if self contains the token

    -

    Implementations on Foreign Types§

    source§

    impl ContainsToken<char> for u8

    source§

    fn contains_token(&self, token: char) -> bool

    source§

    impl ContainsToken<u8> for u8

    source§

    fn contains_token(&self, token: u8) -> bool

    source§

    impl<'a> ContainsToken<&'a char> for u8

    source§

    fn contains_token(&self, token: &char) -> bool

    source§

    impl<'a> ContainsToken<&'a u8> for u8

    source§

    fn contains_token(&self, token: &u8) -> bool

    source§

    impl<C1: AsChar> ContainsToken<C1> for RangeFull

    source§

    fn contains_token(&self, _token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for Range<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeFrom<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeInclusive<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeTo<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeToInclusive<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C: AsChar> ContainsToken<C> for &[char]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<C: AsChar> ContainsToken<C> for &[u8]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<C: AsChar> ContainsToken<C> for char

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<T> ContainsToken<T> for ()

    source§

    fn contains_token(&self, _token: T) -> bool

    source§

    impl<T, F1> ContainsToken<T> for (F1,)
    where +

    Required Methods§

    source

    fn contains_token(&self, token: T) -> bool

    Returns true if self contains the token

    +

    Implementations on Foreign Types§

    source§

    impl ContainsToken<char> for u8

    source§

    fn contains_token(&self, token: char) -> bool

    source§

    impl ContainsToken<u8> for u8

    source§

    fn contains_token(&self, token: u8) -> bool

    source§

    impl<'a> ContainsToken<&'a char> for u8

    source§

    fn contains_token(&self, token: &char) -> bool

    source§

    impl<'a> ContainsToken<&'a u8> for u8

    source§

    fn contains_token(&self, token: &u8) -> bool

    source§

    impl<C1: AsChar> ContainsToken<C1> for RangeFull

    source§

    fn contains_token(&self, _token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for Range<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeFrom<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeInclusive<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeTo<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for RangeToInclusive<C2>

    source§

    fn contains_token(&self, token: C1) -> bool

    source§

    impl<C: AsChar> ContainsToken<C> for &[char]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<C: AsChar> ContainsToken<C> for &[u8]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<C: AsChar> ContainsToken<C> for char

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<T> ContainsToken<T> for ()

    source§

    fn contains_token(&self, _token: T) -> bool

    source§

    impl<T, F1> ContainsToken<T> for (F1,)
    where T: Clone, - F1: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2> ContainsToken<T> for (F1, F2)
    where + F1: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2> ContainsToken<T> for (F1, F2)
    where T: Clone, F1: ContainsToken<T>, - F2: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3> ContainsToken<T> for (F1, F2, F3)
    where + F2: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3> ContainsToken<T> for (F1, F2, F3)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, - F3: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4> ContainsToken<T> for (F1, F2, F3, F4)
    where + F3: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4> ContainsToken<T> for (F1, F2, F3, F4)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, F3: ContainsToken<T>, - F4: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5> ContainsToken<T> for (F1, F2, F3, F4, F5)
    where + F4: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5> ContainsToken<T> for (F1, F2, F3, F4, F5)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, F3: ContainsToken<T>, F4: ContainsToken<T>, - F5: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6> ContainsToken<T> for (F1, F2, F3, F4, F5, F6)
    where + F5: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6> ContainsToken<T> for (F1, F2, F3, F4, F5, F6)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, F3: ContainsToken<T>, F4: ContainsToken<T>, F5: ContainsToken<T>, - F6: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7)
    where + F6: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -57,7 +57,7 @@ F4: ContainsToken<T>, F5: ContainsToken<T>, F6: ContainsToken<T>, - F7: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8)
    where + F7: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -66,7 +66,7 @@ F5: ContainsToken<T>, F6: ContainsToken<T>, F7: ContainsToken<T>, - F8: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9)
    where + F8: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -76,7 +76,7 @@ F6: ContainsToken<T>, F7: ContainsToken<T>, F8: ContainsToken<T>, - F9: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10)
    where + F9: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -87,7 +87,7 @@ F7: ContainsToken<T>, F8: ContainsToken<T>, F9: ContainsToken<T>, - F10: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11)
    where + F10: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -99,7 +99,7 @@ F8: ContainsToken<T>, F9: ContainsToken<T>, F10: ContainsToken<T>, - F11: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12)
    where + F11: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -112,7 +112,7 @@ F9: ContainsToken<T>, F10: ContainsToken<T>, F11: ContainsToken<T>, - F12: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13)
    where + F12: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -126,7 +126,7 @@ F10: ContainsToken<T>, F11: ContainsToken<T>, F12: ContainsToken<T>, - F13: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14)
    where + F13: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -141,7 +141,7 @@ F11: ContainsToken<T>, F12: ContainsToken<T>, F13: ContainsToken<T>, - F14: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15)
    where + F14: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -157,7 +157,7 @@ F12: ContainsToken<T>, F13: ContainsToken<T>, F14: ContainsToken<T>, - F15: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16)
    where + F15: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -174,7 +174,7 @@ F13: ContainsToken<T>, F14: ContainsToken<T>, F15: ContainsToken<T>, - F16: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17)
    where + F16: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -192,7 +192,7 @@ F14: ContainsToken<T>, F15: ContainsToken<T>, F16: ContainsToken<T>, - F17: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18)
    where + F17: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -211,7 +211,7 @@ F15: ContainsToken<T>, F16: ContainsToken<T>, F17: ContainsToken<T>, - F18: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19)
    where + F18: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -231,7 +231,7 @@ F16: ContainsToken<T>, F17: ContainsToken<T>, F18: ContainsToken<T>, - F19: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20)
    where + F19: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -252,7 +252,7 @@ F17: ContainsToken<T>, F18: ContainsToken<T>, F19: ContainsToken<T>, - F20: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21)
    where + F20: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<T, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21> ContainsToken<T> for (F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21)
    where T: Clone, F1: ContainsToken<T>, F2: ContainsToken<T>, @@ -274,4 +274,4 @@ F18: ContainsToken<T>, F19: ContainsToken<T>, F20: ContainsToken<T>, - F21: ContainsToken<T>,

    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for &[char; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for &[u8; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for [char; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for [u8; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    Implementors§

    source§

    impl<C, F: Fn(C) -> bool> ContainsToken<C> for F

    \ No newline at end of file + F21: ContainsToken<T>,
    source§

    fn contains_token(&self, token: T) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for &[char; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for &[u8; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for [char; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    source§

    impl<const LEN: usize, C: AsChar> ContainsToken<C> for [u8; LEN]

    source§

    fn contains_token(&self, token: C) -> bool

    Implementors§

    source§

    impl<C, F: Fn(C) -> bool> ContainsToken<C> for F

    \ No newline at end of file diff --git a/winnow/stream/trait.FindSlice.html b/winnow/stream/trait.FindSlice.html index 1b416bc06..3ddbafd05 100644 --- a/winnow/stream/trait.FindSlice.html +++ b/winnow/stream/trait.FindSlice.html @@ -1,21 +1,21 @@ -FindSlice in winnow::stream - Rust
    -

    Trait winnow::stream::FindSlice

    source · 
    pub trait FindSlice<T> {
+FindSlice in winnow::stream - Rust
    
+    
    Trait winnow::stream::FindSlice
    source · 
    pub trait FindSlice<T> {
     // Required method
     fn find_slice(&self, substr: T) -> Option<Range<usize>>;
 }
    Expand description
    Look for a slice in self
    
-
    Required Methods§
    source
    fn find_slice(&self, substr: T) -> Option<Range<usize>>
    Returns the offset of the slice if it is found
    
-
    Implementations on Foreign Types§
    source§
    impl<'i> FindSlice<(char, char)> for &'i str
    source§
    fn find_slice(&self, substr: (char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char, char)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char, char, char)> for &'i str
    source§
    fn find_slice(&self, substr: (char, char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char, char, char)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (char, char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char,)> for &'i str
    source§
    fn find_slice(&self, substr: (char,)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char,)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (char,)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(u8, u8)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (u8, u8)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(u8, u8, u8)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (u8, u8, u8)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(u8,)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (u8,)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<char> for &'i str
    source§
    fn find_slice(&self, substr: char) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<char> for &'i [u8]
    source§
    fn find_slice(&self, substr: char) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<u8> for &'i [u8]
    source§
    fn find_slice(&self, substr: u8) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<&'s str> for &'i str
    source§
    fn find_slice(&self, substr: &'s str) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<&'s str> for &'i [u8]
    source§
    fn find_slice(&self, substr: &'s str) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<&'s [u8]> for &'i [u8]
    source§
    fn find_slice(&self, substr: &'s [u8]) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i str
    source§
    fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i str
    source§
    fn find_slice(
+
    Required Methods§
    source
    fn find_slice(&self, substr: T) -> Option<Range<usize>>
    Returns the offset of the slice if it is found
    
+
    Implementations on Foreign Types§
    source§
    impl<'i> FindSlice<(char, char)> for &'i str
    source§
    fn find_slice(&self, substr: (char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char, char)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char, char, char)> for &'i str
    source§
    fn find_slice(&self, substr: (char, char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char, char, char)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (char, char, char)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char,)> for &'i str
    source§
    fn find_slice(&self, substr: (char,)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(char,)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (char,)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(u8, u8)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (u8, u8)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(u8, u8, u8)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (u8, u8, u8)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<(u8,)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (u8,)) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<char> for &'i str
    source§
    fn find_slice(&self, substr: char) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<char> for &'i [u8]
    source§
    fn find_slice(&self, substr: char) -> Option<Range<usize>>
    source§
    impl<'i> FindSlice<u8> for &'i [u8]
    source§
    fn find_slice(&self, substr: u8) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<&'s str> for &'i str
    source§
    fn find_slice(&self, substr: &'s str) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<&'s str> for &'i [u8]
    source§
    fn find_slice(&self, substr: &'s str) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<&'s [u8]> for &'i [u8]
    source§
    fn find_slice(&self, substr: &'s [u8]) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i str
    source§
    fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i str
    source§
    fn find_slice(
     &self,
     substr: (&'s str, &'s str, &'s str)
-) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i [u8]
    source§
    fn find_slice(
+) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i [u8]
    source§
    fn find_slice(
     &self,
     substr: (&'s str, &'s str, &'s str)
-) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str,)> for &'i str
    source§
    fn find_slice(&self, substr: (&'s str,)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str,)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s str,)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s [u8], &'s [u8])> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s [u8], &'s [u8])) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s [u8], &'s [u8], &'s [u8])> for &'i [u8]
    source§
    fn find_slice(
+) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str,)> for &'i str
    source§
    fn find_slice(&self, substr: (&'s str,)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s str,)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s str,)) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s [u8], &'s [u8])> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s [u8], &'s [u8])) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s [u8], &'s [u8], &'s [u8])> for &'i [u8]
    source§
    fn find_slice(
     &self,
     substr: (&'s [u8], &'s [u8], &'s [u8])
-) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s [u8],)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s [u8],)) -> Option<Range<usize>>
    Implementors§
    source§
    impl<'i, S> FindSlice<S> for &'i BStr
    where
-    &'i [u8]: FindSlice<S>,
    source§
    impl<'i, S> FindSlice<S> for &'i Bytes
    where
-    &'i [u8]: FindSlice<S>,
    source§
    impl<I, S, T> FindSlice<T> for Stateful<I, S>
    where
-    I: FindSlice<T>,
    source§
    impl<I, T> FindSlice<T> for Located<I>
    where
-    I: FindSlice<T>,
    source§
    impl<I, T> FindSlice<T> for Partial<I>
    where
+) -> Option<Range<usize>>
    source§
    impl<'i, 's> FindSlice<(&'s [u8],)> for &'i [u8]
    source§
    fn find_slice(&self, substr: (&'s [u8],)) -> Option<Range<usize>>
    Implementors§
    source§
    impl<'i, S> FindSlice<S> for &'i BStr
    where
+    &'i [u8]: FindSlice<S>,
    source§
    impl<'i, S> FindSlice<S> for &'i Bytes
    where
+    &'i [u8]: FindSlice<S>,
    source§
    impl<I, S, T> FindSlice<T> for Stateful<I, S>
    where
+    I: FindSlice<T>,
    source§
    impl<I, T> FindSlice<T> for Located<I>
    where
+    I: FindSlice<T>,
    source§
    impl<I, T> FindSlice<T> for Partial<I>
    where
     I: FindSlice<T>,
    
\ No newline at end of file
diff --git a/winnow/stream/trait.Location.html b/winnow/stream/trait.Location.html
index 1ad572fa7..da49ce80a 100644
--- a/winnow/stream/trait.Location.html
+++ b/winnow/stream/trait.Location.html
@@ -1,11 +1,11 @@
-Location in winnow::stream - Rust
    
-    
    Trait winnow::stream::Location
    source · 
    pub trait Location {
+Location in winnow::stream - Rust
    
+    
    Trait winnow::stream::Location
    source · 
    pub trait Location {
     // Required method
     fn location(&self) -> usize;
 }
    Expand description
    Number of indices input has advanced since start of parsing
    
 
    See Located for adding location tracking to your Stream
    
-
    Required Methods§
    source
    fn location(&self) -> usize
    Number of indices input has advanced since start of parsing
    
-
    Implementors§
    source§
    impl<I> Location for Located<I>
    where
-    I: Clone + Offset,
    source§
    impl<I> Location for Partial<I>
    where
-    I: Location,
    source§
    impl<I, S> Location for Stateful<I, S>
    where
+
    Required Methods§
    source
    fn location(&self) -> usize
    Number of indices input has advanced since start of parsing
    
+
    Implementors§
    source§
    impl<I> Location for Located<I>
    where
+    I: Clone + Offset,
    source§
    impl<I> Location for Partial<I>
    where
+    I: Location,
    source§
    impl<I, S> Location for Stateful<I, S>
    where
     I: Location,
    
\ No newline at end of file
diff --git a/winnow/stream/trait.Offset.html b/winnow/stream/trait.Offset.html
index 02a25f85b..288050de7 100644
--- a/winnow/stream/trait.Offset.html
+++ b/winnow/stream/trait.Offset.html
@@ -1,21 +1,21 @@
-Offset in winnow::stream - Rust
    
-    
    Trait winnow::stream::Offset
    source · 
    pub trait Offset<Start = Self> {
+Offset in winnow::stream - Rust
    
+    
    Trait winnow::stream::Offset
    source · 
    pub trait Offset<Start = Self> {
     // Required method
     fn offset_from(&self, start: &Start) -> usize;
 }
    Expand description
    Useful functions to calculate the offset between slices and show a hexdump of a slice
    
-
    Required Methods§
    source
    fn offset_from(&self, start: &Start) -> usize
    Offset between the first byte of start and the first byte of selfa
    
+
    Required Methods§
    source
    fn offset_from(&self, start: &Start) -> usize
    Offset between the first byte of start and the first byte of selfa
    
 
    Note: This is an offset, not an index, and may point to the end of input
 (start.len()) when self is exhausted.
    
-
    Implementations on Foreign Types§
    source§
    impl<'a> Offset for &'a str
    source§
    fn offset_from(&self, start: &Self) -> usize
    source§
    impl<'a> Offset<<&'a str as Stream>::Checkpoint> for &'a str
    source§
    fn offset_from(&self, other: &<&'a str as Stream>::Checkpoint) -> usize
    source§
    impl<'a, T> Offset for &'a [T]
    source§
    fn offset_from(&self, start: &Self) -> usize
    source§
    impl<'a, T> Offset<<&'a [T] as Stream>::Checkpoint> for &'a [T]
    where
-    T: Clone + Debug,
    source§
    fn offset_from(&self, other: &<&'a [T] as Stream>::Checkpoint) -> usize
    source§
    impl<I> Offset for (I, usize)
    where
-    I: Offset,
    source§
    fn offset_from(&self, start: &Self) -> usize
    source§
    impl<I> Offset<<(I, usize) as Stream>::Checkpoint> for (I, usize)
    where
-    I: Stream<Token = u8> + Clone,
    source§
    fn offset_from(&self, other: &<(I, usize) as Stream>::Checkpoint) -> usize
    Implementors§
    source§
    impl<'a> Offset for &'a BStr
    source§
    impl<'a> Offset for &'a Bytes
    source§
    impl<'a> Offset<<&'a BStr as Stream>::Checkpoint> for &'a BStr
    source§
    impl<'a> Offset<<&'a Bytes as Stream>::Checkpoint> for &'a Bytes
    source§
    impl<I> Offset for Located<I>
    where
-    I: Stream,
    source§
    impl<I> Offset for Partial<I>
    where
-    I: Stream,
    source§
    impl<I> Offset<<Located<I> as Stream>::Checkpoint> for Located<I>
    where
-    I: Stream,
    source§
    impl<I> Offset<<Partial<I> as Stream>::Checkpoint> for Partial<I>
    where
-    I: Stream,
    source§
    impl<I, S> Offset for Checkpoint<I, S>
    where
-    I: Offset,
    source§
    impl<I, S> Offset for Stateful<I, S>
    where
+
    Implementations on Foreign Types§
    source§
    impl<'a> Offset for &'a str
    source§
    fn offset_from(&self, start: &Self) -> usize
    source§
    impl<'a> Offset<<&'a str as Stream>::Checkpoint> for &'a str
    source§
    fn offset_from(&self, other: &<&'a str as Stream>::Checkpoint) -> usize
    source§
    impl<'a, T> Offset for &'a [T]
    source§
    fn offset_from(&self, start: &Self) -> usize
    source§
    impl<'a, T> Offset<<&'a [T] as Stream>::Checkpoint> for &'a [T]
    where
+    T: Clone + Debug,
    source§
    fn offset_from(&self, other: &<&'a [T] as Stream>::Checkpoint) -> usize
    source§
    impl<I> Offset for (I, usize)
    where
+    I: Offset,
    source§
    fn offset_from(&self, start: &Self) -> usize
    source§
    impl<I> Offset<<(I, usize) as Stream>::Checkpoint> for (I, usize)
    where
+    I: Stream<Token = u8> + Clone,
    source§
    fn offset_from(&self, other: &<(I, usize) as Stream>::Checkpoint) -> usize
    Implementors§
    source§
    impl<'a> Offset for &'a BStr
    source§
    impl<'a> Offset for &'a Bytes
    source§
    impl<'a> Offset<<&'a BStr as Stream>::Checkpoint> for &'a BStr
    source§
    impl<'a> Offset<<&'a Bytes as Stream>::Checkpoint> for &'a Bytes
    source§
    impl<I> Offset for Located<I>
    where
+    I: Stream,
    source§
    impl<I> Offset for Partial<I>
    where
+    I: Stream,
    source§
    impl<I> Offset<<Located<I> as Stream>::Checkpoint> for Located<I>
    where
+    I: Stream,
    source§
    impl<I> Offset<<Partial<I> as Stream>::Checkpoint> for Partial<I>
    where
+    I: Stream,
    source§
    impl<I, S> Offset for Checkpoint<I, S>
    where
+    I: Offset,
    source§
    impl<I, S> Offset for Stateful<I, S>
    where
     I: Stream,
-    S: Clone + Debug,
    source§
    impl<I, S> Offset<<Stateful<I, S> as Stream>::Checkpoint> for Stateful<I, S>
    where
+    S: Clone + Debug,
    source§
    impl<I, S> Offset<<Stateful<I, S> as Stream>::Checkpoint> for Stateful<I, S>
    where
     I: Stream,
     S: Debug,
    
\ No newline at end of file
diff --git a/winnow/stream/trait.ParseSlice.html b/winnow/stream/trait.ParseSlice.html
index fe2b7f54f..a69882fd3 100644
--- a/winnow/stream/trait.ParseSlice.html
+++ b/winnow/stream/trait.ParseSlice.html
@@ -1,9 +1,9 @@
-ParseSlice in winnow::stream - Rust
    
-    
    Trait winnow::stream::ParseSlice
    source · 
    pub trait ParseSlice<R> {
+ParseSlice in winnow::stream - Rust
    
+    
    Trait winnow::stream::ParseSlice
    source · 
    pub trait ParseSlice<R> {
     // Required method
     fn parse_slice(&self) -> Option<R>;
 }
    Expand description
    Used to integrate str’s parse() method
    
-
    Required Methods§
    source
    fn parse_slice(&self) -> Option<R>
    Succeeds if parse() succeeded
    
+
    Required Methods§
    source
    fn parse_slice(&self) -> Option<R>
    Succeeds if parse() succeeded
    
 
    The byte slice implementation will first convert it to a &str, then apply the parse()
 function
    
-
    Implementations on Foreign Types§
    source§
    impl<'a, R: FromStr> ParseSlice<R> for &'a str
    source§
    fn parse_slice(&self) -> Option<R>
    source§
    impl<'a, R: FromStr> ParseSlice<R> for &'a [u8]
    source§
    fn parse_slice(&self) -> Option<R>
    Implementors§
    
\ No newline at end of file
+
    Implementations on Foreign Types§
    source§
    impl<'a, R: FromStr> ParseSlice<R> for &'a str
    source§
    fn parse_slice(&self) -> Option<R>
    source§
    impl<'a, R: FromStr> ParseSlice<R> for &'a [u8]
    source§
    fn parse_slice(&self) -> Option<R>
    Implementors§
    
\ No newline at end of file
diff --git a/winnow/stream/trait.SliceLen.html b/winnow/stream/trait.SliceLen.html
index 95f08e1ce..79cf0ee3d 100644
--- a/winnow/stream/trait.SliceLen.html
+++ b/winnow/stream/trait.SliceLen.html
@@ -1,12 +1,12 @@
-SliceLen in winnow::stream - Rust
    
-    
    Trait winnow::stream::SliceLen
    source · 
    pub trait SliceLen {
+SliceLen in winnow::stream - Rust
    
+    
    Trait winnow::stream::SliceLen
    source · 
    pub trait SliceLen {
     // Required method
     fn slice_len(&self) -> usize;
 }
    Expand description
    Abstract method to calculate the input length
    
-
    Required Methods§
    source
    fn slice_len(&self) -> usize
    Calculates the input length, as indicated by its name,
+
    Required Methods§
    source
    fn slice_len(&self) -> usize
    Calculates the input length, as indicated by its name,
 and the name of the trait itself
    
-
    Implementations on Foreign Types§
    source§
    impl SliceLen for char
    source§
    fn slice_len(&self) -> usize
    source§
    impl SliceLen for u8
    source§
    fn slice_len(&self) -> usize
    source§
    impl<'a> SliceLen for &'a str
    source§
    fn slice_len(&self) -> usize
    source§
    impl<'a, T> SliceLen for &'a [T]
    source§
    fn slice_len(&self) -> usize
    source§
    impl<'a, T, const LEN: usize> SliceLen for &'a [T; LEN]
    source§
    fn slice_len(&self) -> usize
    source§
    impl<I> SliceLen for (I, usize, usize)
    where
-    I: SliceLen,
    source§
    fn slice_len(&self) -> usize
    source§
    impl<T, const LEN: usize> SliceLen for [T; LEN]
    source§
    fn slice_len(&self) -> usize
    Implementors§
    source§
    impl<'a> SliceLen for &'a BStr
    source§
    impl<'a> SliceLen for &'a Bytes
    source§
    impl<I> SliceLen for Located<I>
    where
-    I: SliceLen,
    source§
    impl<I> SliceLen for Partial<I>
    where
-    I: SliceLen,
    source§
    impl<I, S> SliceLen for Stateful<I, S>
    where
-    I: SliceLen,
    source§
    impl<S: SliceLen> SliceLen for Caseless<S>
    
\ No newline at end of file
+

    Implementations on Foreign Types§

    source§

    impl SliceLen for char

    source§

    fn slice_len(&self) -> usize

    source§

    impl SliceLen for u8

    source§

    fn slice_len(&self) -> usize

    source§

    impl<'a> SliceLen for &'a str

    source§

    fn slice_len(&self) -> usize

    source§

    impl<'a, T> SliceLen for &'a [T]

    source§

    fn slice_len(&self) -> usize

    source§

    impl<'a, T, const LEN: usize> SliceLen for &'a [T; LEN]

    source§

    fn slice_len(&self) -> usize

    source§

    impl<I> SliceLen for (I, usize, usize)
    where + I: SliceLen,

    source§

    fn slice_len(&self) -> usize

    source§

    impl<T, const LEN: usize> SliceLen for [T; LEN]

    source§

    fn slice_len(&self) -> usize

    Implementors§

    source§

    impl<'a> SliceLen for &'a BStr

    source§

    impl<'a> SliceLen for &'a Bytes

    source§

    impl<I> SliceLen for Located<I>
    where + I: SliceLen,

    source§

    impl<I> SliceLen for Partial<I>
    where + I: SliceLen,

    source§

    impl<I, S> SliceLen for Stateful<I, S>
    where + I: SliceLen,

    source§

    impl<S: SliceLen> SliceLen for Caseless<S>

    \ No newline at end of file diff --git a/winnow/stream/trait.Stream.html b/winnow/stream/trait.Stream.html index 75e8a4d0e..6128ccea2 100644 --- a/winnow/stream/trait.Stream.html +++ b/winnow/stream/trait.Stream.html @@ -1,5 +1,5 @@ -Stream in winnow::stream - Rust
    -

    Trait winnow::stream::Stream

    source · 
    pub trait Stream: Offset<Self::Checkpoint> + Debug {
+Stream in winnow::stream - Rust
    
+    
    Trait winnow::stream::Stream
    source · 
    pub trait Stream: Offset<Self::Checkpoint> + Debug {
     type Token: Debug;
     type Slice: Debug;
     type IterOffsets: Iterator<Item = (usize, Self::Token)>;
@@ -26,20 +26,20 @@
     fn peek_finish(&self) -> (Self, Self::Slice)
        where Self: Clone { ... }
 }
    Expand description
    Core definition for parser input state
    
-
    Required Associated Types§
    source
    type Token: Debug
    The smallest unit being parsed
    
+
    Required Associated Types§
    source
    type Token: Debug
    The smallest unit being parsed
    
 
    Example: u8 for &[u8] or char for &str
    
-
    source
    type Slice: Debug
    Sequence of Tokens
    
+
    source
    type Slice: Debug
    Sequence of Tokens
    
 
    Example: &[u8] for Located<&[u8]> or &str for Located<&str>
    
-
    source
    type IterOffsets: Iterator<Item = (usize, Self::Token)>
    Iterate with the offset from the current location
    
-
    source
    type Checkpoint: Offset + Clone + Debug
    A parse location within the stream
    
-
    Required Methods§
    source
    fn iter_offsets(&self) -> Self::IterOffsets
    Iterate with the offset from the current location
    
-
    source
    fn eof_offset(&self) -> usize
    Returns the offset to the end of the input
    
-
    source
    fn next_token(&mut self) -> Option<Self::Token>
    Split off the next token from the input
    
-
    source
    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where
+
    source
    type IterOffsets: Iterator<Item = (usize, Self::Token)>
    Iterate with the offset from the current location
    
+
    source
    type Checkpoint: Offset + Clone + Debug
    A parse location within the stream
    
+
    Required Methods§
    source
    fn iter_offsets(&self) -> Self::IterOffsets
    Iterate with the offset from the current location
    
+
    source
    fn eof_offset(&self) -> usize
    Returns the offset to the end of the input
    
+
    source
    fn next_token(&mut self) -> Option<Self::Token>
    Split off the next token from the input
    
+
    source
    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where
     P: Fn(Self::Token) -> bool,
    Finds the offset of the next matching token
    
-
    source
    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>
    Get the offset for the number of tokens into the stream
    
+
    source
    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>
    Get the offset for the number of tokens into the stream
    
 
    This means “0 tokens” will return 0 offset
    
-
    source
    fn next_slice(&mut self, offset: usize) -> Self::Slice
    Split off a slice of tokens from the input
    
+
    source
    fn next_slice(&mut self, offset: usize) -> Self::Slice
    Split off a slice of tokens from the input
    
 
    NOTE: For inputs with variable width tokens, like &str’s char, offset might not correspond
 with the number of tokens. To get a valid offset, use:
    
 
      
@@ -55,21 +55,21 @@ with the number of tokens. To get a valid offset, use:
      
 
    • Indexes must uphold invariants of the stream, like for str they must lie on UTF-8
 sequence boundaries.
      • 
 
    
-
    source
    fn checkpoint(&self) -> Self::Checkpoint
    Save the current parse location within the stream
    
-
    source
    fn reset(&mut self, checkpoint: &Self::Checkpoint)
    Revert the stream to a prior Self::Checkpoint
    
+
    source
    fn checkpoint(&self) -> Self::Checkpoint
    Save the current parse location within the stream
    
+
    source
    fn reset(&mut self, checkpoint: &Self::Checkpoint)
    Revert the stream to a prior Self::Checkpoint
    
 
    §Panic
    
 
    May panic if an invalid Self::Checkpoint is provided
    
-
    source
    fn raw(&self) -> &dyn Debug
    Return the inner-most stream
    
-
    Provided Methods§
    source
    fn peek_token(&self) -> Option<(Self, Self::Token)>
    where
+
    source
    fn raw(&self) -> &dyn Debug
    Return the inner-most stream
    
+
    Provided Methods§
    source
    fn peek_token(&self) -> Option<(Self, Self::Token)>
    where
     Self: Clone,
    Split off the next token from the input
    
-
    source
    fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
    where
+
    source
    fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
    where
     Self: Clone,
    Split off a slice of tokens from the input
    
-
    source
    fn finish(&mut self) -> Self::Slice
    Advance to the end of the stream
    
-
    source
    fn peek_finish(&self) -> (Self, Self::Slice)
    where
+
    source
    fn finish(&mut self) -> Self::Slice
    Advance to the end of the stream
    
+
    source
    fn peek_finish(&self) -> (Self, Self::Slice)
    where
     Self: Clone,
    Advance to the end of the stream
    
-
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<'i> Stream for &'i str
    §
    type Token = char
    §
    type Slice = &'i str
    §
    type IterOffsets = CharIndices<'i>
    §
    type Checkpoint = Checkpoint<&'i str, &'i str>
    source§
    fn iter_offsets(&self) -> Self::IterOffsets
    source§
    fn eof_offset(&self) -> usize
    source§
    fn next_token(&mut self) -> Option<Self::Token>
    source§
    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where
-    P: Fn(Self::Token) -> bool,
    source§
    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>
    source§
    fn next_slice(&mut self, offset: usize) -> Self::Slice
    source§
    fn checkpoint(&self) -> Self::Checkpoint
    source§
    fn reset(&mut self, checkpoint: &Self::Checkpoint)
    source§
    fn raw(&self) -> &dyn Debug
    source§
    impl<'i, T> Stream for &'i [T]
    where
-    T: Clone + Debug,
    §
    type Token = T
    §
    type Slice = &'i [T]
    §
    type IterOffsets = Enumerate<Cloned<Iter<'i, T>>>
    §
    type Checkpoint = Checkpoint<&'i [T], &'i [T]>
    source§
    fn iter_offsets(&self) -> Self::IterOffsets
    source§
    fn eof_offset(&self) -> usize
    source§
    fn next_token(&mut self) -> Option<Self::Token>
    source§
    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where
-    P: Fn(Self::Token) -> bool,
    source§
    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>
    source§
    fn next_slice(&mut self, offset: usize) -> Self::Slice
    source§
    fn checkpoint(&self) -> Self::Checkpoint
    source§
    fn reset(&mut self, checkpoint: &Self::Checkpoint)
    source§
    fn raw(&self) -> &dyn Debug
    source§
    impl<I> Stream for (I, usize)
    where
-    I: Stream<Token = u8> + Clone,
    §
    type Token = bool
    §
    type Slice = (<I as Stream>::Slice, usize, usize)
    §
    type IterOffsets = BitOffsets<I>
    §
    type Checkpoint = Checkpoint<(<I as Stream>::Checkpoint, usize), (I, usize)>
    source§
    fn iter_offsets(&self) -> Self::IterOffsets
    source§
    fn eof_offset(&self) -> usize
    source§
    fn next_token(&mut self) -> Option<Self::Token>
    source§
    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where
-    P: Fn(Self::Token) -> bool,
    source§
    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>
    source§
    fn next_slice(&mut self, offset: usize) -> Self::Slice
    source§
    fn checkpoint(&self) -> Self::Checkpoint
    source§
    fn reset(&mut self, checkpoint: &Self::Checkpoint)
    source§
    fn raw(&self) -> &dyn Debug
    Implementors§
    source§
    impl<'i> Stream for &'i BStr
    §
    type Token = u8
    §
    type Slice = &'i [u8]
    §
    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>
    §
    type Checkpoint = Checkpoint<&'i BStr, &'i BStr>
    source§
    impl<'i> Stream for &'i Bytes
    §
    type Token = u8
    §
    type Slice = &'i [u8]
    §
    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>
    §
    type Checkpoint = Checkpoint<&'i Bytes, &'i Bytes>
    source§
    impl<I: Stream> Stream for Located<I>
    §
    type Token = <I as Stream>::Token
    §
    type Slice = <I as Stream>::Slice
    §
    type IterOffsets = <I as Stream>::IterOffsets
    §
    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Located<I>>
    source§
    impl<I: Stream> Stream for Partial<I>
    §
    type Token = <I as Stream>::Token
    §
    type Slice = <I as Stream>::Slice
    §
    type IterOffsets = <I as Stream>::IterOffsets
    §
    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Partial<I>>
    source§
    impl<I: Stream, S: Debug> Stream for Stateful<I, S>
    §
    type Token = <I as Stream>::Token
    §
    type Slice = <I as Stream>::Slice
    §
    type IterOffsets = <I as Stream>::IterOffsets
    §
    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Stateful<I, S>>
    
\ No newline at end of file
+

    Object Safety§

    This trait is not object safe.

    Implementations on Foreign Types§

    source§

    impl<'i> Stream for &'i str

    §

    type Token = char

    §

    type Slice = &'i str

    §

    type IterOffsets = CharIndices<'i>

    §

    type Checkpoint = Checkpoint<&'i str, &'i str>

    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    source§

    fn eof_offset(&self) -> usize

    source§

    fn next_token(&mut self) -> Option<Self::Token>

    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    source§

    fn checkpoint(&self) -> Self::Checkpoint

    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    source§

    fn raw(&self) -> &dyn Debug

    source§

    impl<'i, T> Stream for &'i [T]
    where + T: Clone + Debug,

    §

    type Token = T

    §

    type Slice = &'i [T]

    §

    type IterOffsets = Enumerate<Cloned<Iter<'i, T>>>

    §

    type Checkpoint = Checkpoint<&'i [T], &'i [T]>

    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    source§

    fn eof_offset(&self) -> usize

    source§

    fn next_token(&mut self) -> Option<Self::Token>

    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    source§

    fn checkpoint(&self) -> Self::Checkpoint

    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    source§

    fn raw(&self) -> &dyn Debug

    source§

    impl<I> Stream for (I, usize)
    where + I: Stream<Token = u8> + Clone,

    §

    type Token = bool

    §

    type Slice = (<I as Stream>::Slice, usize, usize)

    §

    type IterOffsets = BitOffsets<I>

    §

    type Checkpoint = Checkpoint<(<I as Stream>::Checkpoint, usize), (I, usize)>

    source§

    fn iter_offsets(&self) -> Self::IterOffsets

    source§

    fn eof_offset(&self) -> usize

    source§

    fn next_token(&mut self) -> Option<Self::Token>

    source§

    fn offset_for<P>(&self, predicate: P) -> Option<usize>
    where + P: Fn(Self::Token) -> bool,

    source§

    fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

    source§

    fn next_slice(&mut self, offset: usize) -> Self::Slice

    source§

    fn checkpoint(&self) -> Self::Checkpoint

    source§

    fn reset(&mut self, checkpoint: &Self::Checkpoint)

    source§

    fn raw(&self) -> &dyn Debug

    Implementors§

    source§

    impl<'i> Stream for &'i BStr

    §

    type Token = u8

    §

    type Slice = &'i [u8]

    §

    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>

    §

    type Checkpoint = Checkpoint<&'i BStr, &'i BStr>

    source§

    impl<'i> Stream for &'i Bytes

    §

    type Token = u8

    §

    type Slice = &'i [u8]

    §

    type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>

    §

    type Checkpoint = Checkpoint<&'i Bytes, &'i Bytes>

    source§

    impl<I: Stream> Stream for Located<I>

    §

    type Token = <I as Stream>::Token

    §

    type Slice = <I as Stream>::Slice

    §

    type IterOffsets = <I as Stream>::IterOffsets

    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Located<I>>

    source§

    impl<I: Stream> Stream for Partial<I>

    §

    type Token = <I as Stream>::Token

    §

    type Slice = <I as Stream>::Slice

    §

    type IterOffsets = <I as Stream>::IterOffsets

    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Partial<I>>

    source§

    impl<I: Stream, S: Debug> Stream for Stateful<I, S>

    §

    type Token = <I as Stream>::Token

    §

    type Slice = <I as Stream>::Slice

    §

    type IterOffsets = <I as Stream>::IterOffsets

    §

    type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Stateful<I, S>>

    \ No newline at end of file diff --git a/winnow/stream/trait.StreamIsPartial.html b/winnow/stream/trait.StreamIsPartial.html index b8b613d49..99d976268 100644 --- a/winnow/stream/trait.StreamIsPartial.html +++ b/winnow/stream/trait.StreamIsPartial.html @@ -1,5 +1,5 @@ -StreamIsPartial in winnow::stream - Rust
    -

    Trait winnow::stream::StreamIsPartial

    source · 
    pub trait StreamIsPartial: Sized {
+StreamIsPartial in winnow::stream - Rust
    
+    
    Trait winnow::stream::StreamIsPartial
    source · 
    pub trait StreamIsPartial: Sized {
     type PartialState;
 
     // Required methods
@@ -11,13 +11,13 @@
     fn is_partial(&self) -> bool { ... }
 }
    Expand description
    Marks the input as being the complete buffer or a partial buffer for streaming input
    
 
    See Partial for marking a presumed complete buffer type as a streaming buffer.
    
-
    Required Associated Types§
    source
    type PartialState
    Whether the stream is currently partial or complete
    
-
    Required Methods§
    source
    fn complete(&mut self) -> Self::PartialState
    Mark the stream is complete
    
-
    source
    fn restore_partial(&mut self, state: Self::PartialState)
    Restore the stream back to its previous state
    
-
    source
    fn is_partial_supported() -> bool
    Report whether the Stream is can ever be incomplete
    
-
    Provided Methods§
    source
    fn is_partial(&self) -> bool
    Report whether the Stream is currently incomplete
    
-
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<'a> StreamIsPartial for &'a str
    §
    type PartialState = ()
    source§
    fn complete(&mut self) -> Self::PartialState
    source§
    fn restore_partial(&mut self, _state: Self::PartialState)
    source§
    fn is_partial_supported() -> bool
    source§
    impl<'a, T> StreamIsPartial for &'a [T]
    §
    type PartialState = ()
    source§
    fn complete(&mut self) -> Self::PartialState
    source§
    fn restore_partial(&mut self, _state: Self::PartialState)
    source§
    fn is_partial_supported() -> bool
    source§
    impl<I> StreamIsPartial for (I, usize)
    where
-    I: StreamIsPartial,
    §
    type PartialState = <I as StreamIsPartial>::PartialState
    source§
    fn complete(&mut self) -> Self::PartialState
    source§
    fn restore_partial(&mut self, state: Self::PartialState)
    source§
    fn is_partial_supported() -> bool
    source§
    fn is_partial(&self) -> bool
    Implementors§
    source§
    impl<'a> StreamIsPartial for &'a BStr
    §
    type PartialState = ()
    source§
    impl<'a> StreamIsPartial for &'a Bytes
    §
    type PartialState = ()
    source§
    impl<I> StreamIsPartial for Located<I>
    where
-    I: StreamIsPartial,
    §
    type PartialState = <I as StreamIsPartial>::PartialState
    source§
    impl<I> StreamIsPartial for Partial<I>
    where
-    I: StreamIsPartial,
    §
    type PartialState = bool
    source§
    impl<I, S> StreamIsPartial for Stateful<I, S>
    where
+
    Required Associated Types§
    source
    type PartialState
    Whether the stream is currently partial or complete
    
+
    Required Methods§
    source
    fn complete(&mut self) -> Self::PartialState
    Mark the stream is complete
    
+
    source
    fn restore_partial(&mut self, state: Self::PartialState)
    Restore the stream back to its previous state
    
+
    source
    fn is_partial_supported() -> bool
    Report whether the Stream is can ever be incomplete
    
+
    Provided Methods§
    source
    fn is_partial(&self) -> bool
    Report whether the Stream is currently incomplete
    
+
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<'a> StreamIsPartial for &'a str
    §
    type PartialState = ()
    source§
    fn complete(&mut self) -> Self::PartialState
    source§
    fn restore_partial(&mut self, _state: Self::PartialState)
    source§
    fn is_partial_supported() -> bool
    source§
    impl<'a, T> StreamIsPartial for &'a [T]
    §
    type PartialState = ()
    source§
    fn complete(&mut self) -> Self::PartialState
    source§
    fn restore_partial(&mut self, _state: Self::PartialState)
    source§
    fn is_partial_supported() -> bool
    source§
    impl<I> StreamIsPartial for (I, usize)
    where
+    I: StreamIsPartial,
    §
    type PartialState = <I as StreamIsPartial>::PartialState
    source§
    fn complete(&mut self) -> Self::PartialState
    source§
    fn restore_partial(&mut self, state: Self::PartialState)
    source§
    fn is_partial_supported() -> bool
    source§
    fn is_partial(&self) -> bool
    Implementors§
    
\ No newline at end of file
diff --git a/winnow/stream/trait.ToUsize.html b/winnow/stream/trait.ToUsize.html
index 418830e4e..1d3f391d8 100644
--- a/winnow/stream/trait.ToUsize.html
+++ b/winnow/stream/trait.ToUsize.html
@@ -1,5 +1,5 @@
-ToUsize in winnow::stream - Rust
    
-    
    Trait winnow::stream::ToUsize
    source · 
    pub trait ToUsize {
+ToUsize in winnow::stream - Rust
    
+    
    Trait winnow::stream::ToUsize
    source · 
    pub trait ToUsize {
     // Required method
     fn to_usize(&self) -> usize;
 }
    Expand description
    Helper trait to convert numbers to usize.
    
@@ -7,5 +7,5 @@
 From<u32> and From<u64> because that would be invalid on some
 platforms. This trait implements the conversion for platforms
 with 32 and 64 bits pointer platforms
    
-
    Required Methods§
    source
    fn to_usize(&self) -> usize
    converts self to usize
    
-
    Implementations on Foreign Types§
    source§
    impl ToUsize for u8
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for u16
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for u32
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for u64
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for usize
    source§
    fn to_usize(&self) -> usize
    Implementors§
    
\ No newline at end of file
+
    Required Methods§
    source
    fn to_usize(&self) -> usize
    converts self to usize
    
+
    Implementations on Foreign Types§
    source§
    impl ToUsize for u8
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for u16
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for u32
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for u64
    source§
    fn to_usize(&self) -> usize
    source§
    impl ToUsize for usize
    source§
    fn to_usize(&self) -> usize
    Implementors§
    \ No newline at end of file diff --git a/winnow/stream/trait.UpdateSlice.html b/winnow/stream/trait.UpdateSlice.html index d989f41a4..aef6b178c 100644 --- a/winnow/stream/trait.UpdateSlice.html +++ b/winnow/stream/trait.UpdateSlice.html @@ -1,12 +1,12 @@ -UpdateSlice in winnow::stream - Rust
    -

    Trait winnow::stream::UpdateSlice

    source · 
    pub trait UpdateSlice: Stream {
+UpdateSlice in winnow::stream - Rust
    
+    
    Trait winnow::stream::UpdateSlice
    source · 
    pub trait UpdateSlice: Stream {
     // Required method
     fn update_slice(self, inner: Self::Slice) -> Self;
 }
    Expand description
    Convert a Stream into an appropriate Output type
    
-
    Required Methods§
    source
    fn update_slice(self, inner: Self::Slice) -> Self
    Convert an Output type to be used as Stream
    
-
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<'a> UpdateSlice for &'a str
    source§
    fn update_slice(self, inner: Self::Slice) -> Self
    source§
    impl<'a, T> UpdateSlice for &'a [T]
    where
-    T: Clone + Debug,
    source§
    fn update_slice(self, inner: Self::Slice) -> Self
    Implementors§
    source§
    impl<'a> UpdateSlice for &'a BStr
    source§
    impl<'a> UpdateSlice for &'a Bytes
    source§
    impl<I> UpdateSlice for Located<I>
    where
-    I: UpdateSlice,
    source§
    impl<I> UpdateSlice for Partial<I>
    where
-    I: UpdateSlice,
    source§
    impl<I, S> UpdateSlice for Stateful<I, S>
    where
+
    Required Methods§
    source
    fn update_slice(self, inner: Self::Slice) -> Self
    Convert an Output type to be used as Stream
    
+
    Object Safety§
    This trait is not object safe.
    Implementations on Foreign Types§
    source§
    impl<'a> UpdateSlice for &'a str
    source§
    fn update_slice(self, inner: Self::Slice) -> Self
    source§
    impl<'a, T> UpdateSlice for &'a [T]
    where
+    T: Clone + Debug,
    source§
    fn update_slice(self, inner: Self::Slice) -> Self
    Implementors§
    source§
    impl<'a> UpdateSlice for &'a BStr
    source§
    impl<'a> UpdateSlice for &'a Bytes
    source§
    impl<I> UpdateSlice for Located<I>
    where
+    I: UpdateSlice,
    source§
    impl<I> UpdateSlice for Partial<I>
    where
+    I: UpdateSlice,
    source§
    impl<I, S> UpdateSlice for Stateful<I, S>
    where
     I: UpdateSlice,
     S: Clone + Debug,
    
\ No newline at end of file
diff --git a/winnow/stream/type.Str.html b/winnow/stream/type.Str.html
index e3a1c4791..c07dc956f 100644
--- a/winnow/stream/type.Str.html
+++ b/winnow/stream/type.Str.html
@@ -1,3 +1,3 @@
-Str in winnow::stream - Rust
    
-    
    Type Alias winnow::stream::Str
    source · 
    pub type Str<'i> = &'i str;
    Expand description
    UTF-8 Stream
    
+Str in winnow::stream - Rust
    
+    
    Type Alias winnow::stream::Str
    source · 
    pub type Str<'i> = &'i str;
    Expand description
    UTF-8 Stream
    
 
    
\ No newline at end of file
diff --git a/winnow/token/fn.any.html b/winnow/token/fn.any.html
index f1b630a34..7fbd0fec0 100644
--- a/winnow/token/fn.any.html
+++ b/winnow/token/fn.any.html
@@ -1,4 +1,4 @@
-any in winnow::token - Rust
    
+any in winnow::token - Rust
    
     
    Function winnow::token::any
    source · 
    pub fn any<Input, Error>(
     input: &mut Input
 ) -> PResult<<Input as Stream>::Token, Error>
    where
diff --git a/winnow/token/fn.literal.html b/winnow/token/fn.literal.html
index 9f8e5f0c9..21a5d20bb 100644
--- a/winnow/token/fn.literal.html
+++ b/winnow/token/fn.literal.html
@@ -1,4 +1,4 @@
-literal in winnow::token - Rust
    
+literal in winnow::token - Rust
    
     
    Function winnow::token::literal
    source · 
    pub fn literal<Literal, Input, Error>(
     literal: Literal
 ) -> impl Parser<Input, <Input as Stream>::Slice, Error>
    where
diff --git a/winnow/token/fn.none_of.html b/winnow/token/fn.none_of.html
index 192bf644f..57316cf28 100644
--- a/winnow/token/fn.none_of.html
+++ b/winnow/token/fn.none_of.html
@@ -1,4 +1,4 @@
-none_of in winnow::token - Rust
    
+none_of in winnow::token - Rust
    
     
    Function winnow::token::none_of
    source · 
    pub fn none_of<Input, Set, Error>(
     set: Set
 ) -> impl Parser<Input, <Input as Stream>::Token, Error>
    where
diff --git a/winnow/token/fn.one_of.html b/winnow/token/fn.one_of.html
index 6ca0f7763..a967797e5 100644
--- a/winnow/token/fn.one_of.html
+++ b/winnow/token/fn.one_of.html
@@ -1,4 +1,4 @@
-one_of in winnow::token - Rust
    
+one_of in winnow::token - Rust
    
     
    Function winnow::token::one_of
    source · 
    pub fn one_of<Input, Set, Error>(
     set: Set
 ) -> impl Parser<Input, <Input as Stream>::Token, Error>
    where
diff --git a/winnow/token/fn.take.html b/winnow/token/fn.take.html
index 5cfb64223..edf1bb98a 100644
--- a/winnow/token/fn.take.html
+++ b/winnow/token/fn.take.html
@@ -1,4 +1,4 @@
-take in winnow::token - Rust
    
+take in winnow::token - Rust
    
     
    Function winnow::token::take
    source · 
    pub fn take<UsizeLike, Input, Error>(
     token_count: UsizeLike
 ) -> impl Parser<Input, <Input as Stream>::Slice, Error>
    where
diff --git a/winnow/token/fn.take_till.html b/winnow/token/fn.take_till.html
index 88b1a06ad..e99a0d9b0 100644
--- a/winnow/token/fn.take_till.html
+++ b/winnow/token/fn.take_till.html
@@ -1,4 +1,4 @@
-take_till in winnow::token - Rust
    
+take_till in winnow::token - Rust
    
     
    Function winnow::token::take_till
    source · 
    pub fn take_till<Set, Input, Error>(
     occurrences: impl Into<Range>,
     set: Set
diff --git a/winnow/token/fn.take_until.html b/winnow/token/fn.take_until.html
index 8e3958eb5..1cbead264 100644
--- a/winnow/token/fn.take_until.html
+++ b/winnow/token/fn.take_until.html
@@ -1,4 +1,4 @@
-take_until in winnow::token - Rust
    
+take_until in winnow::token - Rust
    
     
    Function winnow::token::take_until
    source · 
    pub fn take_until<Literal, Input, Error>(
     occurrences: impl Into<Range>,
     literal: Literal
diff --git a/winnow/token/fn.take_while.html b/winnow/token/fn.take_while.html
index 595ce535a..f6b210992 100644
--- a/winnow/token/fn.take_while.html
+++ b/winnow/token/fn.take_while.html
@@ -1,4 +1,4 @@
-take_while in winnow::token - Rust
    
+take_while in winnow::token - Rust
    
     
    Function winnow::token::take_while
    source · 
    pub fn take_while<Set, Input, Error>(
     occurrences: impl Into<Range>,
     set: Set
diff --git a/winnow/token/index.html b/winnow/token/index.html
index f64e99088..668b2b035 100644
--- a/winnow/token/index.html
+++ b/winnow/token/index.html
@@ -1,3 +1,3 @@
-winnow::token - Rust
    
+winnow::token - Rust
    
     
    Module winnow::token
    source · 
    Expand description
    Parsers extracting tokens from the stream
    
 
    Functions§
    
\ No newline at end of file
diff --git a/winnow/trait.Parser.html b/winnow/trait.Parser.html
index 440d08a5c..b82d9744d 100644
--- a/winnow/trait.Parser.html
+++ b/winnow/trait.Parser.html
@@ -1,5 +1,5 @@
-Parser in winnow - Rust
    
-    
    Trait winnow::Parser
    source · 
    pub trait Parser<I, O, E> {
+Parser in winnow - Rust
    
+    
    Trait winnow::Parser
    source · 
    pub trait Parser<I, O, E> {
 
    Show 22 methods    // Required method
     fn parse_next(&mut self, input: &mut I) -> PResult<O, E>;
 
@@ -109,16 +109,16 @@
 
  • u8 and char, see winnow::token::one_of
    • 
 
  • &[u8] and &str, see winnow::token::literal
    • 
 
-
    Required Methods§
    source
    fn parse_next(&mut self, input: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output
    
+
    Required Methods§
    source
    fn parse_next(&mut self, input: &mut I) -> PResult<O, E>
    Take tokens from the Stream, turning it into the output
    
 
    This includes advancing the Stream to the next location.
    
 
    On error, input will be left pointing at the error location.
    
-
    Provided Methods§
    source
    fn parse(&mut self, input: I) -> Result<O, ParseError<I, E>>
    where
+
    Provided Methods§
    source
    fn parse(&mut self, input: I) -> Result<O, ParseError<I, E>>
    where
     Self: Sized,
     I: Stream + StreamIsPartial + Clone,
     E: ParserError<I>,
    Parse all of input, generating O from it
    
-
    source
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output
    
+
    source
    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>
    Take tokens from the Stream, turning it into the output
    
 
    This includes advancing the Stream to the next location.
    
-
    source
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
+
    source
    fn by_ref(&mut self) -> ByRef<'_, Self>
    where
     Self: Sized,
    Treat &mut Self as a parser
    
 
    This helps when needing to move a Parser when all you have is a &mut Parser.
    
 
    §Example
    
@@ -148,7 +148,7 @@ into Ok(o)
   }
 }
    -
    source

    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where +

    source

    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where Self: Sized, O2: Clone,

    Produce the provided value

    §Example
    @@ -158,7 +158,7 @@ into assert_eq!(parser.parse_peek("abcd"), Ok(("", 1234))); assert_eq!(parser.parse_peek("123abcd;"), Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
    -
    source

    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where +

    source

    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where Self: Sized, O2: Default,

    Produce a type’s default value

    §Example
    @@ -168,7 +168,7 @@ into assert_eq!(parser.parse_peek("abcd"), Ok(("", 0))); assert_eq!(parser.parse_peek("123abcd;"), Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
    -
    source

    fn void(self) -> Void<Self, I, O, E>
    where +

    source

    fn void(self) -> Void<Self, I, O, E>
    where Self: Sized,

    Discards the output of the Parser

    §Example
    use winnow::ascii::alpha1;
@@ -177,7 +177,7 @@ into assert_eq!(parser.parse_peek("abcd"), Ok(("", ())));
 assert_eq!(parser.parse_peek("123abcd;"), Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
    -
    source

    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where +

    source

    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where Self: Sized, O: Into<O2>,

    Convert the parser’s output to another type using std::convert::From

    §Example
    @@ -192,7 +192,7 @@ into // the parser converts the &str output of the child parser into a Vec<u8> let bytes: IResult<&str, Vec<u8>> = parser2.parse_peek("abcd"); assert_eq!(bytes, Ok(("", vec![97, 98, 99, 100])));
    -
    source

    fn recognize(self) -> Recognize<Self, I, O, E>
    where +

    source

    fn recognize(self) -> Recognize<Self, I, O, E>
    where Self: Sized, I: Stream,

    Produce the consumed input as produced value.

    §Example
    @@ -203,7 +203,7 @@ into assert_eq!(parser.parse_peek("abcd,efgh"), Ok(("", "abcd,efgh"))); assert_eq!(parser.parse_peek("abcd;"),Err(ErrMode::Backtrack(InputError::new(";", ErrorKind::Tag))));
    -
    source

    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where +

    source

    fn with_recognized(self) -> WithRecognized<Self, I, O, E>
    where Self: Sized, I: Stream,

    Produce the consumed input with the output

    Functions similarly to recognize except it @@ -232,7 +232,7 @@ as the input, or the input is a user defined type.

    assert_eq!(recognize_parser.parse_peek("1234"), consumed_parser.parse_peek("1234")); assert_eq!(recognize_parser.parse_peek("abcd"), consumed_parser.parse_peek("abcd"));
    -
    source

    fn span(self) -> Span<Self, I, O, E>
    where +

    source

    fn span(self) -> Span<Self, I, O, E>
    where Self: Sized, I: Stream + Location,

    Produce the location of the consumed input as produced value.

    §Example
    @@ -244,7 +244,7 @@ as the input, or the input is a user defined type.

    assert_eq!(parser.parse(Located::new("abcd,efgh")), Ok((0..4, 5..9))); assert_eq!(parser.parse_peek(Located::new("abcd;")),Err(ErrMode::Backtrack(InputError::new(Located::new("abcd;").peek_slice(4).0, ErrorKind::Tag))));
    -
    source

    fn with_span(self) -> WithSpan<Self, I, O, E>
    where +

    source

    fn with_span(self) -> WithSpan<Self, I, O, E>
    where Self: Sized, I: Stream + Location,

    Produce the location of consumed input with the output

    Functions similarly to Parser::span except it @@ -275,7 +275,7 @@ as the input, or the input is a user defined type.

    assert_eq!(recognize_parser.parse_peek(Located::new("1234")), consumed_parser.parse_peek(Located::new("1234"))); assert_eq!(recognize_parser.parse_peek(Located::new("abcd")), consumed_parser.parse_peek(Located::new("abcd")));
    -
    source

    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where +

    source

    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where G: FnMut(O) -> O2, Self: Sized,

    Maps a function over the output of a parser

    §Example
    @@ -289,7 +289,7 @@ as the input, or the input is a user defined type.

    // this will fail if digit1 fails assert_eq!(parser.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Slice))));
    -
    source

    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where +

    source

    fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
    where Self: Sized, G: FnMut(O) -> Result<O2, E2>, I: Stream, @@ -307,7 +307,7 @@ as the input, or the input is a user defined type.

    // this will fail if the mapped function fails (a `u8` is too small to hold `123456`) assert_eq!(parse.parse_peek("123456"), Err(ErrMode::Backtrack(InputError::new("123456", ErrorKind::Verify))));
    -

    source

    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where +

    source

    fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
    where Self: Sized, G: FnMut(O) -> Option<O2>, I: Stream, @@ -325,7 +325,7 @@ as the input, or the input is a user defined type.

    // this will fail if the mapped function fails (a `u8` is too small to hold `123456`) assert_eq!(parse.parse_peek("123456"), Err(ErrMode::Backtrack(InputError::new("123456", ErrorKind::Verify))));
    -

    source

    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where +

    source

    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where Self: Sized, G: FnMut(O) -> H, H: Parser<I, O2, E>,

    Creates a parser from the output of this one

    @@ -352,7 +352,7 @@ as the input, or the input is a user defined type.

    assert_eq!(length_take.parse_peek(&[2, 0, 1, 2][..]), Ok((&[2][..], &[0, 1][..]))); assert_eq!(length_take.parse_peek(&[4, 0, 1, 2][..]), Err(ErrMode::Backtrack(InputError::new(&[0, 1, 2][..], ErrorKind::Slice))));
    -
    source

    fn and_then<G, O2>(self, inner: G) -> AndThen<Self, G, I, O, O2, E>
    where +

    source

    fn and_then<G, O2>(self, inner: G) -> AndThen<Self, G, I, O, O2, E>
    where Self: Sized, G: Parser<O, O2, E>, O: StreamIsPartial, @@ -366,7 +366,7 @@ as the input, or the input is a user defined type.

    assert_eq!(digits.parse_peek("12345"), Ok(("", "12345"))); assert_eq!(digits.parse_peek("123ab"), Ok(("", "123"))); assert_eq!(digits.parse_peek("123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Slice))));
    -

    source

    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where +

    source

    fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
    where Self: Sized, I: Stream, O: ParseSlice<O2>, @@ -384,7 +384,7 @@ as the input, or the input is a user defined type.

    // this will fail if digit1 fails assert_eq!(parser.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Slice))));
    -

    source

    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where +

    source

    fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
    where Self: Sized, G: FnMut(&O2) -> bool, I: Stream, @@ -400,14 +400,14 @@ parser.

    assert_eq!(parser.parse_peek("abcd"), Ok(("", "abcd"))); assert_eq!(parser.parse_peek("abcde"), Err(ErrMode::Backtrack(InputError::new("abcde", ErrorKind::Verify)))); assert_eq!(parser.parse_peek("123abcd;"),Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
    -

    source

    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where +

    source

    fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
    where Self: Sized, I: Stream, E: AddContext<I, C>, C: Clone + Debug,

    If parsing fails, add context to the error

    This is used mainly to add user friendly information to errors when backtracking through a parse tree.

    -
    source

    fn complete_err(self) -> CompleteErr<Self>
    where +

    source

    fn complete_err(self) -> CompleteErr<Self>
    where Self: Sized,

    Transforms Incomplete into Backtrack

    §Example
    
@@ -415,26 +415,26 @@ to errors when backtracking through a parse tree.
    
 
 assert_eq!(parser.parse_peek(Partial::new("abcdefg")), Ok((Partial::new("fg"), "abcde")));
 assert_eq!(parser.parse_peek(Partial::new("abcd")), Err(ErrMode::Backtrack(InputError::new(Partial::new("abcd"), ErrorKind::Complete))));
    -
    source

    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where +

    source

    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where Self: Sized, E: Into<E2>,

    Convert the parser’s error to another type using std::convert::From

    -

    Trait Implementations§

    source§

    impl<'a, I, O, E> Parser<I, O, E> for Box<dyn Parser<I, O, E> + 'a>

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>

    Take tokens from the Stream, turning it into the output Read more
    source§

    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>

    Take tokens from the Stream, turning it into the output Read more
    source§

    fn by_ref(&mut self) -> ByRef<'_, Self>
    where - Self: Sized,

    Treat &mut Self as a parser Read more
    source§

    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where +

    Trait Implementations§

    source§

    impl<'a, I, O, E> Parser<I, O, E> for Box<dyn Parser<I, O, E> + 'a>

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>

    Take tokens from the Stream, turning it into the output Read more
    source§

    fn parse_peek(&mut self, input: I) -> IResult<I, O, E>

    Take tokens from the Stream, turning it into the output Read more
    source§

    fn by_ref(&mut self) -> ByRef<'_, Self>
    where + Self: Sized,

    Treat &mut Self as a parser Read more
    source§

    fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
    where Self: Sized, - O2: Clone,

    Produce the provided value Read more
    source§

    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where + O2: Clone,

    Produce the provided value Read more
    source§

    fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
    where Self: Sized, - O2: Default,

    Produce a type’s default value Read more
    source§

    fn void(self) -> Void<Self, I, O, E>
    where - Self: Sized,

    Discards the output of the Parser Read more
    source§

    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where + O2: Default,

    Produce a type’s default value Read more
    source§

    fn void(self) -> Void<Self, I, O, E>
    where + Self: Sized,

    Discards the output of the Parser Read more
    source§

    fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
    where Self: Sized, - O: Into<O2>,

    Convert the parser’s output to another type using std::convert::From Read more
    source§

    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where + O: Into<O2>,

    Convert the parser’s output to another type using std::convert::From Read more
    source§

    fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
    where G: FnMut(O) -> O2, - Self: Sized,

    Maps a function over the output of a parser Read more
    source§

    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where + Self: Sized,

    Maps a function over the output of a parser Read more
    source§

    fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
    where Self: Sized, G: FnMut(O) -> H, - H: Parser<I, O2, E>,

    Creates a parser from the output of this one Read more
    source§

    fn complete_err(self) -> CompleteErr<Self>
    where - Self: Sized,

    Transforms Incomplete into Backtrack Read more
    source§

    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where + H: Parser<I, O2, E>,

    Creates a parser from the output of this one Read more
    source§

    fn complete_err(self) -> CompleteErr<Self>
    where + Self: Sized,

    Transforms Incomplete into Backtrack Read more
    source§

    fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
    where Self: Sized, - E: Into<E2>,

    Convert the parser’s error to another type using std::convert::From

    Implementations on Foreign Types§

    source§

    impl<'a, I, O, E> Parser<I, O, E> for Box<dyn Parser<I, O, E> + 'a>

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>

    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s str
    where + E: Into<E2>,

    Convert the parser’s error to another type using std::convert::From

    Implementations on Foreign Types§

    source§

    impl<'a, I, O, E> Parser<I, O, E> for Box<dyn Parser<I, O, E> + 'a>

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<O, E>

    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s str
    where I: Compare<&'s str> + StreamIsPartial + Stream,

    This is a shortcut for literal.

    §Example

    
@@ -446,7 +446,7 @@ to errors when backtracking through a parse tree.
    
 assert_eq!(parser.parse_peek("Something"), Ok(("hing", "Somet")));
 assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
    -
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s [u8]
    where +
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s [u8]
    where I: Compare<&'s [u8]> + StreamIsPartial + Stream,

    This is a shortcut for literal.

    §Example

    
@@ -458,7 +458,7 @@ to errors when backtracking through a parse tree.
    
 assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
 assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
    -
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

    source§

    impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E> for &'s [u8; N]
    where +
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

    source§

    impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E> for &'s [u8; N]
    where I: Compare<&'s [u8; N]> + StreamIsPartial + Stream,

    This is a shortcut for literal.

    §Example

    
@@ -470,7 +470,7 @@ to errors when backtracking through a parse tree.
    
 assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
 assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
    -
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

    source§

    impl<I, E> Parser<I, char, E> for char
    where +
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

    source§

    impl<I, E> Parser<I, char, E> for char
    where I: StreamIsPartial + Stream + Compare<char>, E: ParserError<I>,

    This is a shortcut for one_of.

    §Example

    @@ -481,7 +481,7 @@ to errors when backtracking through a parse tree.

    assert_eq!(parser.parse_peek(" abc"), Err(ErrMode::Backtrack(InputError::new(" abc", ErrorKind::Tag)))); assert_eq!(parser.parse_peek("bc"), Err(ErrMode::Backtrack(InputError::new("bc", ErrorKind::Tag)))); assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
    -
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<char, E>

    source§

    impl<I, E> Parser<I, u8, E> for u8
    where +
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<char, E>

    source§

    impl<I, E> Parser<I, u8, E> for u8
    where I: StreamIsPartial + Stream + Compare<u8>, E: ParserError<I>,

    This is a shortcut for one_of.

    §Example

    @@ -492,35 +492,35 @@ to errors when backtracking through a parse tree.

    assert_eq!(parser.parse_peek(&b" abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b" abc"[..], ErrorKind::Tag)))); assert_eq!(parser.parse_peek(&b"bc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"bc"[..], ErrorKind::Tag)))); assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Tag))));
    -
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<u8, E>

    source§

    impl<I: Stream, E: ParserError<I>> Parser<I, (), E> for ()

    source§

    fn parse_next(&mut self, _i: &mut I) -> PResult<(), E>

    source§

    impl<I: Stream, O1, E: ParserError<I>, P1> Parser<I, (O1,), E> for (P1,)
    where - P1: Parser<I, O1, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1,), E>

    source§

    impl<I: Stream, O1, O2, E: ParserError<I>, P1, P2> Parser<I, (O1, O2), E> for (P1, P2)
    where +
    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<u8, E>

    source§

    impl<I: Stream, E: ParserError<I>> Parser<I, (), E> for ()

    source§

    fn parse_next(&mut self, _i: &mut I) -> PResult<(), E>

    source§

    impl<I: Stream, O1, E: ParserError<I>, P1> Parser<I, (O1,), E> for (P1,)
    where + P1: Parser<I, O1, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1,), E>

    source§

    impl<I: Stream, O1, O2, E: ParserError<I>, P1, P2> Parser<I, (O1, O2), E> for (P1, P2)
    where P1: Parser<I, O1, E>, - P2: Parser<I, O2, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2), E>

    source§

    impl<I: Stream, O1, O2, O3, E: ParserError<I>, P1, P2, P3> Parser<I, (O1, O2, O3), E> for (P1, P2, P3)
    where + P2: Parser<I, O2, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2), E>

    source§

    impl<I: Stream, O1, O2, O3, E: ParserError<I>, P1, P2, P3> Parser<I, (O1, O2, O3), E> for (P1, P2, P3)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, - P3: Parser<I, O3, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, E: ParserError<I>, P1, P2, P3, P4> Parser<I, (O1, O2, O3, O4), E> for (P1, P2, P3, P4)
    where + P3: Parser<I, O3, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, E: ParserError<I>, P1, P2, P3, P4> Parser<I, (O1, O2, O3, O4), E> for (P1, P2, P3, P4)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, - P4: Parser<I, O4, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, E: ParserError<I>, P1, P2, P3, P4, P5> Parser<I, (O1, O2, O3, O4, O5), E> for (P1, P2, P3, P4, P5)
    where + P4: Parser<I, O4, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, E: ParserError<I>, P1, P2, P3, P4, P5> Parser<I, (O1, O2, O3, O4, O5), E> for (P1, P2, P3, P4, P5)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, P4: Parser<I, O4, E>, - P5: Parser<I, O5, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4, O5), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, E: ParserError<I>, P1, P2, P3, P4, P5, P6> Parser<I, (O1, O2, O3, O4, O5, O6), E> for (P1, P2, P3, P4, P5, P6)
    where + P5: Parser<I, O5, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4, O5), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, E: ParserError<I>, P1, P2, P3, P4, P5, P6> Parser<I, (O1, O2, O3, O4, O5, O6), E> for (P1, P2, P3, P4, P5, P6)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, P4: Parser<I, O4, E>, P5: Parser<I, O5, E>, - P6: Parser<I, O6, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4, O5, O6), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7> Parser<I, (O1, O2, O3, O4, O5, O6, O7), E> for (P1, P2, P3, P4, P5, P6, P7)
    where + P6: Parser<I, O6, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4, O5, O6), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7> Parser<I, (O1, O2, O3, O4, O5, O6, O7), E> for (P1, P2, P3, P4, P5, P6, P7)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, P4: Parser<I, O4, E>, P5: Parser<I, O5, E>, P6: Parser<I, O6, E>, - P7: Parser<I, O7, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4, O5, O6, O7), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8), E> for (P1, P2, P3, P4, P5, P6, P7, P8)
    where + P7: Parser<I, O7, E>,

    source§

    fn parse_next(&mut self, i: &mut I) -> PResult<(O1, O2, O3, O4, O5, O6, O7), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8), E> for (P1, P2, P3, P4, P5, P6, P7, P8)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -528,10 +528,10 @@ to errors when backtracking through a parse tree.

    P5: Parser<I, O5, E>, P6: Parser<I, O6, E>, P7: Parser<I, O7, E>, - P8: Parser<I, O8, E>,

    source§

    fn parse_next( + P8: Parser<I, O8, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -540,10 +540,10 @@ to errors when backtracking through a parse tree.

    P6: Parser<I, O6, E>, P7: Parser<I, O7, E>, P8: Parser<I, O8, E>, - P9: Parser<I, O9, E>,

    source§

    fn parse_next( + P9: Parser<I, O9, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -553,10 +553,10 @@ to errors when backtracking through a parse tree.

    P7: Parser<I, O7, E>, P8: Parser<I, O8, E>, P9: Parser<I, O9, E>, - P10: Parser<I, O10, E>,

    source§

    fn parse_next( + P10: Parser<I, O10, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -567,10 +567,10 @@ to errors when backtracking through a parse tree.

    P8: Parser<I, O8, E>, P9: Parser<I, O9, E>, P10: Parser<I, O10, E>, - P11: Parser<I, O11, E>,

    source§

    fn parse_next( + P11: Parser<I, O11, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -582,10 +582,10 @@ to errors when backtracking through a parse tree.

    P9: Parser<I, O9, E>, P10: Parser<I, O10, E>, P11: Parser<I, O11, E>, - P12: Parser<I, O12, E>,

    source§

    fn parse_next( + P12: Parser<I, O12, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -598,10 +598,10 @@ to errors when backtracking through a parse tree.

    P10: Parser<I, O10, E>, P11: Parser<I, O11, E>, P12: Parser<I, O12, E>, - P13: Parser<I, O13, E>,

    source§

    fn parse_next( + P13: Parser<I, O13, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -615,10 +615,10 @@ to errors when backtracking through a parse tree.

    P11: Parser<I, O11, E>, P12: Parser<I, O12, E>, P13: Parser<I, O13, E>, - P14: Parser<I, O14, E>,

    source§

    fn parse_next( + P14: Parser<I, O14, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -633,10 +633,10 @@ to errors when backtracking through a parse tree.

    P12: Parser<I, O12, E>, P13: Parser<I, O13, E>, P14: Parser<I, O14, E>, - P15: Parser<I, O15, E>,

    source§

    fn parse_next( + P15: Parser<I, O15, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -652,10 +652,10 @@ to errors when backtracking through a parse tree.

    P13: Parser<I, O13, E>, P14: Parser<I, O14, E>, P15: Parser<I, O15, E>, - P16: Parser<I, O16, E>,

    source§

    fn parse_next( + P16: Parser<I, O16, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -672,10 +672,10 @@ to errors when backtracking through a parse tree.

    P14: Parser<I, O14, E>, P15: Parser<I, O15, E>, P16: Parser<I, O16, E>, - P17: Parser<I, O17, E>,

    source§

    fn parse_next( + P17: Parser<I, O17, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -693,10 +693,10 @@ to errors when backtracking through a parse tree.

    P15: Parser<I, O15, E>, P16: Parser<I, O16, E>, P17: Parser<I, O17, E>, - P18: Parser<I, O18, E>,

    source§

    fn parse_next( + P18: Parser<I, O18, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -715,10 +715,10 @@ to errors when backtracking through a parse tree.

    P16: Parser<I, O16, E>, P17: Parser<I, O17, E>, P18: Parser<I, O18, E>, - P19: Parser<I, O19, E>,

    source§

    fn parse_next( + P19: Parser<I, O19, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -738,10 +738,10 @@ to errors when backtracking through a parse tree.

    P17: Parser<I, O17, E>, P18: Parser<I, O18, E>, P19: Parser<I, O19, E>, - P20: Parser<I, O20, E>,

    source§

    fn parse_next( + P20: Parser<I, O20, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20, P21> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20, P21)
    where +) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20), E>

    source§

    impl<I: Stream, O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21, E: ParserError<I>, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20, P21> Parser<I, (O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21), E> for (P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16, P17, P18, P19, P20, P21)
    where P1: Parser<I, O1, E>, P2: Parser<I, O2, E>, P3: Parser<I, O3, E>, @@ -762,13 +762,13 @@ to errors when backtracking through a parse tree.

    P18: Parser<I, O18, E>, P19: Parser<I, O19, E>, P20: Parser<I, O20, E>, - P21: Parser<I, O21, E>,

    source§

    fn parse_next( + P21: Parser<I, O21, E>,

    source§

    fn parse_next( &mut self, i: &mut I -) -> PResult<(O1, O2, O3, O4, O5, O6, O7, O8, O9, O10, O11, O12, O13, O14, O15, O16, O17, O18, O19, O20, O21), E>

    Implementors§

    Implementors§

    source§

    impl<'a, I, O, E, F> Parser<I, O, E> for F
    where F: FnMut(&mut I) -> PResult<O, E> + 'a, - I: Stream,

    source§

    impl<'p, I, O, E, P> Parser<I, O, E> for ByRef<'p, P>
    where - P: Parser<I, O, E>,

    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s str>
    where + I: Stream,

    source§

    impl<'p, I, O, E, P> Parser<I, O, E> for ByRef<'p, P>
    where + P: Parser<I, O, E>,

    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s str>
    where I: Compare<Caseless<&'s str>> + StreamIsPartial + Stream,

    This is a shortcut for literal.

    §Example

    
@@ -782,7 +782,7 @@ to errors when backtracking through a parse tree.
    
 assert_eq!(parser.parse_peek("Something"), Ok(("hing", "Somet")));
 assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
    -
    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8]>
    where +
    source§

    impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8]>
    where I: Compare<Caseless<&'s [u8]>> + StreamIsPartial + Stream,

    This is a shortcut for literal.

    §Example

    use winnow::ascii::Caseless;
@@ -797,7 +797,7 @@ to errors when backtracking through a parse tree.
    
 assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
 assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
    -
    source§

    impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8; N]>
    where +
    source§

    impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E> for Caseless<&'s [u8; N]>
    where I: Compare<Caseless<&'s [u8; N]>> + StreamIsPartial + Stream,

    This is a shortcut for literal.

    §Example

    use winnow::ascii::Caseless;
@@ -812,58 +812,58 @@ to errors when backtracking through a parse tree.
    
 assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
 assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
 assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
    -
    source§

    impl<F, G, H, I, O, O2, E> Parser<I, O2, E> for FlatMap<F, G, H, I, O, O2, E>
    where +
    source§

    impl<F, G, H, I, O, O2, E> Parser<I, O2, E> for FlatMap<F, G, H, I, O, O2, E>
    where F: Parser<I, O, E>, G: FnMut(O) -> H, - H: Parser<I, O2, E>,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O2, E> for AndThen<F, G, I, O, O2, E>
    where + H: Parser<I, O2, E>,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O2, E> for AndThen<F, G, I, O, O2, E>
    where F: Parser<I, O, E>, G: Parser<O, O2, E>, O: StreamIsPartial, - I: Stream,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O2, E> for Map<F, G, I, O, O2, E>
    where + I: Stream,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O2, E> for Map<F, G, I, O, O2, E>
    where F: Parser<I, O, E>, - G: FnMut(O) -> O2,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O2, E> for VerifyMap<F, G, I, O, O2, E>
    where + G: FnMut(O) -> O2,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O2, E> for VerifyMap<F, G, I, O, O2, E>
    where F: Parser<I, O, E>, G: FnMut(O) -> Option<O2>, I: Stream, - E: ParserError<I>,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O, E> for Verify<F, G, I, O, O2, E>
    where + E: ParserError<I>,

    source§

    impl<F, G, I, O, O2, E> Parser<I, O, E> for Verify<F, G, I, O, O2, E>
    where F: Parser<I, O, E>, G: FnMut(&O2) -> bool, I: Stream, O: Borrow<O2>, O2: ?Sized, - E: ParserError<I>,

    source§

    impl<F, G, I, O, O2, E, E2> Parser<I, O2, E> for TryMap<F, G, I, O, O2, E, E2>
    where + E: ParserError<I>,

    source§

    impl<F, G, I, O, O2, E, E2> Parser<I, O2, E> for TryMap<F, G, I, O, O2, E, E2>
    where F: Parser<I, O, E>, G: FnMut(O) -> Result<O2, E2>, I: Stream, - E: FromExternalError<I, E2>,

    source§

    impl<F, I, O, E> Parser<I, (O, <I as Stream>::Slice), E> for WithRecognized<F, I, O, E>
    where + E: FromExternalError<I, E2>,

    source§

    impl<F, I, O, E> Parser<I, (O, <I as Stream>::Slice), E> for WithRecognized<F, I, O, E>
    where F: Parser<I, O, E>, - I: Stream,

    source§

    impl<F, I, O, E> Parser<I, (O, Range<usize>), E> for WithSpan<F, I, O, E>
    where + I: Stream,

    source§

    impl<F, I, O, E> Parser<I, (O, Range<usize>), E> for WithSpan<F, I, O, E>
    where F: Parser<I, O, E>, - I: Stream + Location,

    source§

    impl<F, I, O, E> Parser<I, (), E> for Void<F, I, O, E>
    where - F: Parser<I, O, E>,

    source§

    impl<F, I, O, E> Parser<I, O, E> for CompleteErr<F>
    where + I: Stream + Location,

    source§

    impl<F, I, O, E> Parser<I, (), E> for Void<F, I, O, E>
    where + F: Parser<I, O, E>,

    source§

    impl<F, I, O, E> Parser<I, O, E> for CompleteErr<F>
    where I: Stream, F: Parser<I, O, E>, - E: ParserError<I>,

    source§

    impl<F, I, O, E, C> Parser<I, O, E> for Context<F, I, O, E, C>
    where + E: ParserError<I>,

    source§

    impl<F, I, O, E, C> Parser<I, O, E> for Context<F, I, O, E, C>
    where F: Parser<I, O, E>, I: Stream, E: AddContext<I, C>, - C: Clone + Debug,

    source§

    impl<F, I, O, E, E2> Parser<I, O, E2> for ErrInto<F, I, O, E, E2>
    where + C: Clone + Debug,

    source§

    impl<F, I, O, E, E2> Parser<I, O, E2> for ErrInto<F, I, O, E, E2>
    where F: Parser<I, O, E>, - E: Into<E2>,

    source§

    impl<F, I, O, O2, E> Parser<I, O2, E> for DefaultValue<F, I, O, O2, E>
    where + E: Into<E2>,

    source§

    impl<F, I, O, O2, E> Parser<I, O2, E> for DefaultValue<F, I, O, O2, E>
    where F: Parser<I, O, E>, - O2: Default,

    source§

    impl<F, I, O, O2, E> Parser<I, O2, E> for OutputInto<F, I, O, O2, E>
    where + O2: Default,

    source§

    impl<F, I, O, O2, E> Parser<I, O2, E> for OutputInto<F, I, O, O2, E>
    where F: Parser<I, O, E>, - O: Into<O2>,

    source§

    impl<F, I, O, O2, E> Parser<I, O2, E> for Value<F, I, O, O2, E>
    where + O: Into<O2>,

    source§

    impl<F, I, O, O2, E> Parser<I, O2, E> for Value<F, I, O, O2, E>
    where F: Parser<I, O, E>, - O2: Clone,

    source§

    impl<I, O, E, F> Parser<I, <I as Stream>::Slice, E> for Recognize<F, I, O, E>
    where + O2: Clone,

    source§

    impl<I, O, E, F> Parser<I, <I as Stream>::Slice, E> for Recognize<F, I, O, E>
    where F: Parser<I, O, E>, - I: Stream,

    source§

    impl<I, O, E, F> Parser<I, Range<usize>, E> for Span<F, I, O, E>
    where + I: Stream,

    source§

    impl<I, O, E, F> Parser<I, Range<usize>, E> for Span<F, I, O, E>
    where F: Parser<I, O, E>, I: Stream + Location,

    source§

    impl<P, I, O, C, E> Parser<I, C, E> for Repeat<P, I, O, C, E>
    where P: Parser<I, O, E>, I: Stream, C: Accumulate<O>, - E: ParserError<I>,

    source§

    impl<P, I, O, O2, E> Parser<I, O2, E> for ParseTo<P, I, O, O2, E>
    where + E: ParserError<I>,

    source§

    impl<P, I, O, O2, E> Parser<I, O2, E> for ParseTo<P, I, O, O2, E>
    where P: Parser<I, O, E>, I: Stream, O: ParseSlice<O2>,