Struct reth::revm::revm::interpreter::primitives::Signature
pub struct Signature { /* private fields */ }Expand description
An Ethereum ECDSA signature.
Implementations§
§impl Signature
impl Signature
pub fn decode_rlp_vrs(buf: &mut &[u8]) -> Result<Signature, Error>
rlp only.
pub fn decode_rlp_vrs(buf: &mut &[u8]) -> Result<Signature, Error>
rlp only.Decode an RLP-encoded VRS signature.
§impl Signature
impl Signature
pub fn new(r: Uint<256, 4>, s: Uint<256, 4>, v: Parity) -> Signature
pub fn new(r: Uint<256, 4>, s: Uint<256, 4>, v: Parity) -> Signature
Instantiate a new signature from r, s, and v values.
pub fn into_inner(self) -> Signature<Secp256k1>
Signature::to_k256 insteadAvailable on crate feature k256 only.
pub fn into_inner(self) -> Signature<Secp256k1>
Signature::to_k256 insteadk256 only.Returns the inner ECDSA signature.
pub fn to_k256(self) -> Result<Signature<Secp256k1>, Error>
k256 only.
pub fn to_k256(self) -> Result<Signature<Secp256k1>, Error>
k256 only.Returns the inner ECDSA signature.
pub fn from_signature_and_parity<T, E>(
sig: Signature<Secp256k1>,
parity: T,
) -> Result<Signature, SignatureError>
k256 only.
pub fn from_signature_and_parity<T, E>( sig: Signature<Secp256k1>, parity: T, ) -> Result<Signature, SignatureError>
k256 only.Instantiate from a signature and recovery id
pub fn from_scalars_and_parity<T, E>(
r: FixedBytes<32>,
s: FixedBytes<32>,
parity: T,
) -> Result<Signature, SignatureError>
pub fn from_scalars_and_parity<T, E>( r: FixedBytes<32>, s: FixedBytes<32>, parity: T, ) -> Result<Signature, SignatureError>
Creates a Signature from the serialized r and s scalar values, which comprise the
ECDSA signature, alongside a v value, used to determine the recovery ID.
pub fn normalize_s(&self) -> Option<Signature>
pub fn normalize_s(&self) -> Option<Signature>
Normalizes the signature into “low S” form as described in BIP 0062: Dealing with Malleability.
pub const fn recid(&self) -> RecoveryId
k256 only.
pub const fn recid(&self) -> RecoveryId
k256 only.Returns the recovery ID.
pub fn recover_address_from_msg<T>(
&self,
msg: T,
) -> Result<Address, SignatureError>
k256 only.
pub fn recover_address_from_msg<T>( &self, msg: T, ) -> Result<Address, SignatureError>
k256 only.pub fn recover_address_from_prehash(
&self,
prehash: &FixedBytes<32>,
) -> Result<Address, SignatureError>
k256 only.
pub fn recover_address_from_prehash( &self, prehash: &FixedBytes<32>, ) -> Result<Address, SignatureError>
k256 only.Recovers an Address from this signature and the given prehashed message.
pub fn recover_from_msg<T>(
&self,
msg: T,
) -> Result<VerifyingKey<Secp256k1>, SignatureError>
k256 only.
pub fn recover_from_msg<T>( &self, msg: T, ) -> Result<VerifyingKey<Secp256k1>, SignatureError>
k256 only.Recovers a VerifyingKey from this signature and the given message by first prefixing and
hashing the message according to EIP-191.
pub fn recover_from_prehash(
&self,
prehash: &FixedBytes<32>,
) -> Result<VerifyingKey<Secp256k1>, SignatureError>
k256 only.
pub fn recover_from_prehash( &self, prehash: &FixedBytes<32>, ) -> Result<VerifyingKey<Secp256k1>, SignatureError>
k256 only.Recovers a VerifyingKey from this signature and the given prehashed message.
pub fn from_bytes_and_parity<T, E>(
bytes: &[u8],
parity: T,
) -> Result<Signature, SignatureError>
pub fn from_bytes_and_parity<T, E>( bytes: &[u8], parity: T, ) -> Result<Signature, SignatureError>
Parses a signature from a byte slice, with a v value
§Panics
If the slice is not at least 64 bytes long.
pub fn from_rs_and_parity<T, E>(
r: Uint<256, 4>,
s: Uint<256, 4>,
parity: T,
) -> Result<Signature, SignatureError>
pub fn from_rs_and_parity<T, E>( r: Uint<256, 4>, s: Uint<256, 4>, parity: T, ) -> Result<Signature, SignatureError>
Instantiate from v, r, s.
pub fn with_chain_id(self, chain_id: u64) -> Signature
pub fn with_chain_id(self, chain_id: u64) -> Signature
Modifies the recovery ID by applying EIP-155 to a v value.
pub fn with_parity_bool(self) -> Signature
pub fn with_parity_bool(self) -> Signature
Modifies the recovery ID by dropping any [EIP-155] v value, converting to a simple parity bool.
pub fn as_bytes(&self) -> [u8; 65]
pub fn as_bytes(&self) -> [u8; 65]
Returns the byte-array representation of this signature.
The first 32 bytes are the r value, the second 32 bytes the s value
and the final byte is the v value in ‘Electrum’ notation.
pub fn with_parity<T>(self, parity: T) -> Signature
pub fn with_parity<T>(self, parity: T) -> Signature
Sets the recovery ID by normalizing a v value.
pub fn rlp_rs_len(&self) -> usize
rlp only.
pub fn rlp_rs_len(&self) -> usize
rlp only.Length of RLP RS field encoding
pub fn rlp_vrs_len(&self) -> usize
rlp only.
pub fn rlp_vrs_len(&self) -> usize
rlp only.Length of RLP V field encoding
pub fn write_rlp_rs(&self, out: &mut dyn BufMut)
rlp only.
pub fn write_rlp_rs(&self, out: &mut dyn BufMut)
rlp only.Write R and S to an RLP buffer in progress.
pub fn write_rlp_v(&self, out: &mut dyn BufMut)
rlp only.
pub fn write_rlp_v(&self, out: &mut dyn BufMut)
rlp only.Write the V to an RLP buffer without using EIP-155.
pub fn write_rlp_vrs(&self, out: &mut dyn BufMut)
rlp only.
pub fn write_rlp_vrs(&self, out: &mut dyn BufMut)
rlp only.Write the VRS to the output. The V will always be 27 or 28.
Trait Implementations§
§impl<'a> Arbitrary<'a> for Signature
Available on crate feature arbitrary only.
impl<'a> Arbitrary<'a> for Signature
Available on crate feature
arbitrary only.§fn arbitrary(u: &mut Unstructured<'a>) -> Result<Signature, Error>
fn arbitrary(u: &mut Unstructured<'a>) -> Result<Signature, Error>
Generate an arbitrary value of
Self from the given unstructured data. Read more§fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
Generate an arbitrary value of
Self from the entirety of the given
unstructured data. Read more§impl Arbitrary for Signature
Available on crate feature arbitrary only.
impl Arbitrary for Signature
Available on crate feature
arbitrary only.§type Parameters = ()
type Parameters = ()
The type of parameters that
arbitrary_with accepts for configuration
of the generated Strategy. Parameters must implement Default.§type Strategy = FilterMap<<(Uint<256, 4>, Uint<256, 4>, Parity) as Arbitrary>::Strategy, fn(_: (Uint<256, 4>, Uint<256, 4>, Parity)) -> Option<Signature>>
type Strategy = FilterMap<<(Uint<256, 4>, Uint<256, 4>, Parity) as Arbitrary>::Strategy, fn(_: (Uint<256, 4>, Uint<256, 4>, Parity)) -> Option<Signature>>
The type of
Strategy used to generate values of type Self.§fn arbitrary_with(
_: <Signature as Arbitrary>::Parameters,
) -> <Signature as Arbitrary>::Strategy
fn arbitrary_with( _: <Signature as Arbitrary>::Parameters, ) -> <Signature as Arbitrary>::Strategy
§impl<'de> Deserialize<'de> for Signature
Available on crate feature serde only.
impl<'de> Deserialize<'de> for Signature
Available on crate feature
serde only.§fn deserialize<D>(
deserializer: D,
) -> Result<Signature, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<Signature, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
§impl EncodableSignature for Signature
impl EncodableSignature for Signature
§fn from_rs_and_parity<P, E>(
r: Uint<256, 4>,
s: Uint<256, 4>,
parity: P,
) -> Result<Signature, SignatureError>
fn from_rs_and_parity<P, E>( r: Uint<256, 4>, s: Uint<256, 4>, parity: P, ) -> Result<Signature, SignatureError>
Instantiate from v, r, s.
§fn with_parity<T>(self, parity: T) -> Signature
fn with_parity<T>(self, parity: T) -> Signature
Sets the recovery ID by normalizing a
v value.§fn with_chain_id(self, chain_id: u64) -> Selfwhere
Self: Copy,
fn with_chain_id(self, chain_id: u64) -> Selfwhere
Self: Copy,
Modifies the recovery ID by applying EIP-155 to a
v value.§fn with_parity_bool(self) -> Selfwhere
Self: Copy,
fn with_parity_bool(self) -> Selfwhere
Self: Copy,
Modifies the recovery ID by dropping any [EIP-155] v value, converting
to a simple parity bool.
§fn decode_rlp_vrs(buf: &mut &[u8]) -> Result<Self, Error>
fn decode_rlp_vrs(buf: &mut &[u8]) -> Result<Self, Error>
Decode an RLP-encoded VRS signature.
§fn rlp_rs_len(&self) -> usize
fn rlp_rs_len(&self) -> usize
Length of RLP RS field encoding
§fn rlp_vrs_len(&self) -> usize
fn rlp_vrs_len(&self) -> usize
Length of RLP V field encoding
§fn write_rlp_rs(&self, out: &mut dyn BufMut)
fn write_rlp_rs(&self, out: &mut dyn BufMut)
Write R and S to an RLP buffer in progress.
§fn write_rlp_v(&self, out: &mut dyn BufMut)
fn write_rlp_v(&self, out: &mut dyn BufMut)
Write the V to an RLP buffer without using EIP-155.
§fn write_rlp_vrs(&self, out: &mut dyn BufMut)
fn write_rlp_vrs(&self, out: &mut dyn BufMut)
Write the VRS to the output. The V will always be 27 or 28.
§impl Serialize for Signature
Available on crate feature serde only.
impl Serialize for Signature
Available on crate feature
serde only.§fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
§impl SignableTransaction<Signature> for TxEip1559
impl SignableTransaction<Signature> for TxEip1559
§fn set_chain_id(&mut self, chain_id: u64)
fn set_chain_id(&mut self, chain_id: u64)
Sets
chain_id. Read more§fn encode_for_signing(&self, out: &mut dyn BufMut)
fn encode_for_signing(&self, out: &mut dyn BufMut)
RLP-encodes the transaction for signing.
§fn payload_len_for_signature(&self) -> usize
fn payload_len_for_signature(&self) -> usize
Outputs the length of the signature RLP encoding for the transaction.
§fn into_signed(self, signature: Signature) -> Signed<TxEip1559>
fn into_signed(self, signature: Signature) -> Signed<TxEip1559>
Convert to a signed transaction by adding a signature and computing the
hash.
§fn use_eip155(&self) -> bool
fn use_eip155(&self) -> bool
True if the transaction uses EIP-155 signatures.
§fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
Set
chain_id if it is not already set. Checks that the provided chain_id matches the
existing chain_id if it is already set, returning false if they do not match.§fn encoded_for_signing(&self) -> Vec<u8> ⓘ
fn encoded_for_signing(&self) -> Vec<u8> ⓘ
RLP-encodes the transaction for signing it. Used to calculate
signature_hash. Read more§fn signature_hash(&self) -> FixedBytes<32>
fn signature_hash(&self) -> FixedBytes<32>
Calculate the signing hash for the transaction.
§impl SignableTransaction<Signature> for TxEip2930
impl SignableTransaction<Signature> for TxEip2930
§fn set_chain_id(&mut self, chain_id: u64)
fn set_chain_id(&mut self, chain_id: u64)
Sets
chain_id. Read more§fn encode_for_signing(&self, out: &mut dyn BufMut)
fn encode_for_signing(&self, out: &mut dyn BufMut)
RLP-encodes the transaction for signing.
§fn payload_len_for_signature(&self) -> usize
fn payload_len_for_signature(&self) -> usize
Outputs the length of the signature RLP encoding for the transaction.
§fn into_signed(self, signature: Signature) -> Signed<TxEip2930>
fn into_signed(self, signature: Signature) -> Signed<TxEip2930>
Convert to a signed transaction by adding a signature and computing the
hash.
§fn use_eip155(&self) -> bool
fn use_eip155(&self) -> bool
True if the transaction uses EIP-155 signatures.
§fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
Set
chain_id if it is not already set. Checks that the provided chain_id matches the
existing chain_id if it is already set, returning false if they do not match.§fn encoded_for_signing(&self) -> Vec<u8> ⓘ
fn encoded_for_signing(&self) -> Vec<u8> ⓘ
RLP-encodes the transaction for signing it. Used to calculate
signature_hash. Read more§fn signature_hash(&self) -> FixedBytes<32>
fn signature_hash(&self) -> FixedBytes<32>
Calculate the signing hash for the transaction.
§impl SignableTransaction<Signature> for TxEip4844
impl SignableTransaction<Signature> for TxEip4844
§fn set_chain_id(&mut self, chain_id: u64)
fn set_chain_id(&mut self, chain_id: u64)
Sets
chain_id. Read more§fn encode_for_signing(&self, out: &mut dyn BufMut)
fn encode_for_signing(&self, out: &mut dyn BufMut)
RLP-encodes the transaction for signing.
§fn payload_len_for_signature(&self) -> usize
fn payload_len_for_signature(&self) -> usize
Outputs the length of the signature RLP encoding for the transaction.
§fn into_signed(self, signature: Signature) -> Signed<TxEip4844>
fn into_signed(self, signature: Signature) -> Signed<TxEip4844>
Convert to a signed transaction by adding a signature and computing the
hash.
§fn use_eip155(&self) -> bool
fn use_eip155(&self) -> bool
True if the transaction uses EIP-155 signatures.
§fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
Set
chain_id if it is not already set. Checks that the provided chain_id matches the
existing chain_id if it is already set, returning false if they do not match.§fn encoded_for_signing(&self) -> Vec<u8> ⓘ
fn encoded_for_signing(&self) -> Vec<u8> ⓘ
RLP-encodes the transaction for signing it. Used to calculate
signature_hash. Read more§fn signature_hash(&self) -> FixedBytes<32>
fn signature_hash(&self) -> FixedBytes<32>
Calculate the signing hash for the transaction.
§impl SignableTransaction<Signature> for TxEip7702
impl SignableTransaction<Signature> for TxEip7702
§fn set_chain_id(&mut self, chain_id: u64)
fn set_chain_id(&mut self, chain_id: u64)
Sets
chain_id. Read more§fn encode_for_signing(&self, out: &mut dyn BufMut)
fn encode_for_signing(&self, out: &mut dyn BufMut)
RLP-encodes the transaction for signing.
§fn payload_len_for_signature(&self) -> usize
fn payload_len_for_signature(&self) -> usize
Outputs the length of the signature RLP encoding for the transaction.
§fn into_signed(self, signature: Signature) -> Signed<TxEip7702>
fn into_signed(self, signature: Signature) -> Signed<TxEip7702>
Convert to a signed transaction by adding a signature and computing the
hash.
§fn use_eip155(&self) -> bool
fn use_eip155(&self) -> bool
True if the transaction uses EIP-155 signatures.
§fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
Set
chain_id if it is not already set. Checks that the provided chain_id matches the
existing chain_id if it is already set, returning false if they do not match.§fn encoded_for_signing(&self) -> Vec<u8> ⓘ
fn encoded_for_signing(&self) -> Vec<u8> ⓘ
RLP-encodes the transaction for signing it. Used to calculate
signature_hash. Read more§fn signature_hash(&self) -> FixedBytes<32>
fn signature_hash(&self) -> FixedBytes<32>
Calculate the signing hash for the transaction.
§impl SignableTransaction<Signature> for TxLegacy
impl SignableTransaction<Signature> for TxLegacy
§fn use_eip155(&self) -> bool
fn use_eip155(&self) -> bool
True if the transaction uses EIP-155 signatures.
§fn set_chain_id(&mut self, chain_id: u64)
fn set_chain_id(&mut self, chain_id: u64)
Sets
chain_id. Read more§fn encode_for_signing(&self, out: &mut dyn BufMut)
fn encode_for_signing(&self, out: &mut dyn BufMut)
RLP-encodes the transaction for signing.
§fn payload_len_for_signature(&self) -> usize
fn payload_len_for_signature(&self) -> usize
Outputs the length of the signature RLP encoding for the transaction.
§fn into_signed(self, signature: Signature) -> Signed<TxLegacy>
fn into_signed(self, signature: Signature) -> Signed<TxLegacy>
Convert to a signed transaction by adding a signature and computing the
hash.
§fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
fn set_chain_id_checked(&mut self, chain_id: u64) -> bool
Set
chain_id if it is not already set. Checks that the provided chain_id matches the
existing chain_id if it is already set, returning false if they do not match.§fn encoded_for_signing(&self) -> Vec<u8> ⓘ
fn encoded_for_signing(&self) -> Vec<u8> ⓘ
RLP-encodes the transaction for signing it. Used to calculate
signature_hash. Read more§fn signature_hash(&self) -> FixedBytes<32>
fn signature_hash(&self) -> FixedBytes<32>
Calculate the signing hash for the transaction.
§impl<'a> TryFrom<&'a [u8]> for Signature
impl<'a> TryFrom<&'a [u8]> for Signature
§fn try_from(
bytes: &'a [u8],
) -> Result<Signature, <Signature as TryFrom<&'a [u8]>>::Error>
fn try_from( bytes: &'a [u8], ) -> Result<Signature, <Signature as TryFrom<&'a [u8]>>::Error>
Parses a raw signature which is expected to be 65 bytes long where
the first 32 bytes is the r value, the second 32 bytes the s value
and the final byte is the v value in ‘Electrum’ notation.
§type Error = SignatureError
type Error = SignatureError
The type returned in the event of a conversion error.
impl Copy for Signature
impl Eq for Signature
impl StructuralPartialEq for Signature
Auto Trait Implementations§
impl Freeze for Signature
impl RefUnwindSafe for Signature
impl Send for Signature
impl Sync for Signature
impl Unpin for Signature
impl UnwindSafe for Signature
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
impl<A> ArbInterop for A
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
impl<T> NippyJarHeader for T
impl<T> RpcObject for Twhere
T: RpcParam + RpcReturn,
impl<T> RpcParam for T
impl<T> RpcReturn for T
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 80 bytes