Struct ITIP20ChannelReserveInstance
pub struct ITIP20ChannelReserveInstance<P, N = Ethereum> {
address: Address,
provider: P,
_network: PhantomData<N>,
}Expand description
A ITIP20ChannelReserve instance.
Contains type-safe methods for interacting with an on-chain instance of the
ITIP20ChannelReserve contract located at a given address, using a given
provider P.
If the contract bytecode is available (see the sol!
documentation on how to provide it), the deploy and deploy_builder methods can
be used to deploy a new instance of the contract.
See the module-level documentation for all the available methods.
Fields§
§address: Address§provider: P§_network: PhantomData<N>Implementations§
§impl<P, N> ITIP20ChannelReserveInstance<P, N>where
P: Provider<N>,
N: Network,
Instantiation and getters/setters.
impl<P, N> ITIP20ChannelReserveInstance<P, N>where
P: Provider<N>,
N: Network,
Instantiation and getters/setters.
pub const fn new(
address: Address,
__provider: P,
) -> ITIP20ChannelReserveInstance<P, N>
pub const fn new( address: Address, __provider: P, ) -> ITIP20ChannelReserveInstance<P, N>
Creates a new wrapper around an on-chain ITIP20ChannelReserve contract instance.
See the wrapper’s documentation for more details.
pub fn set_address(&mut self, address: Address)
pub fn set_address(&mut self, address: Address)
Sets the address.
pub fn at(self, address: Address) -> ITIP20ChannelReserveInstance<P, N>
pub fn at(self, address: Address) -> ITIP20ChannelReserveInstance<P, N>
Sets the address and returns self.
§impl<P, N> ITIP20ChannelReserveInstance<&P, N>where
P: Clone,
impl<P, N> ITIP20ChannelReserveInstance<&P, N>where
P: Clone,
pub fn with_cloned_provider(self) -> ITIP20ChannelReserveInstance<P, N>
pub fn with_cloned_provider(self) -> ITIP20ChannelReserveInstance<P, N>
Clones the provider and returns a new instance with the cloned provider.
§impl<P, N> ITIP20ChannelReserveInstance<P, N>where
P: Provider<N>,
N: Network,
Function calls.
impl<P, N> ITIP20ChannelReserveInstance<P, N>where
P: Provider<N>,
N: Network,
Function calls.
pub fn call_builder<C>(&self, call: &C) -> CallBuilder<&P, PhantomData<C>, N>where
C: SolCall,
pub fn call_builder<C>(&self, call: &C) -> CallBuilder<&P, PhantomData<C>, N>where
C: SolCall,
Creates a new call builder using this contract instance’s provider and address.
Note that the call can be any function call, not just those defined in this contract. Prefer using the other methods for building type-safe contract calls.
pub fn CLOSE_GRACE_PERIOD(
&self,
) -> CallBuilder<&P, PhantomData<CLOSE_GRACE_PERIODCall>, N>
pub fn CLOSE_GRACE_PERIOD( &self, ) -> CallBuilder<&P, PhantomData<CLOSE_GRACE_PERIODCall>, N>
Creates a new call builder for the [CLOSE_GRACE_PERIOD] function.
pub fn VOUCHER_TYPEHASH(
&self,
) -> CallBuilder<&P, PhantomData<VOUCHER_TYPEHASHCall>, N>
pub fn VOUCHER_TYPEHASH( &self, ) -> CallBuilder<&P, PhantomData<VOUCHER_TYPEHASHCall>, N>
Creates a new call builder for the [VOUCHER_TYPEHASH] function.
pub fn open(
&self,
payee: Address,
operator: Address,
token: Address,
deposit: Uint<96, 2>,
salt: FixedBytes<32>,
authorizedSigner: Address,
) -> CallBuilder<&P, PhantomData<openCall>, N>
pub fn open( &self, payee: Address, operator: Address, token: Address, deposit: Uint<96, 2>, salt: FixedBytes<32>, authorizedSigner: Address, ) -> CallBuilder<&P, PhantomData<openCall>, N>
Creates a new call builder for the [open] function.
pub fn settle(
&self,
descriptor: <ChannelDescriptor as SolType>::RustType,
cumulativeAmount: Uint<96, 2>,
signature: Bytes,
) -> CallBuilder<&P, PhantomData<settleCall>, N>
pub fn settle( &self, descriptor: <ChannelDescriptor as SolType>::RustType, cumulativeAmount: Uint<96, 2>, signature: Bytes, ) -> CallBuilder<&P, PhantomData<settleCall>, N>
Creates a new call builder for the [settle] function.
pub fn topUp(
&self,
descriptor: <ChannelDescriptor as SolType>::RustType,
additionalDeposit: Uint<96, 2>,
) -> CallBuilder<&P, PhantomData<topUpCall>, N>
pub fn topUp( &self, descriptor: <ChannelDescriptor as SolType>::RustType, additionalDeposit: Uint<96, 2>, ) -> CallBuilder<&P, PhantomData<topUpCall>, N>
Creates a new call builder for the [topUp] function.
pub fn close(
&self,
descriptor: <ChannelDescriptor as SolType>::RustType,
cumulativeAmount: Uint<96, 2>,
captureAmount: Uint<96, 2>,
signature: Bytes,
) -> CallBuilder<&P, PhantomData<closeCall>, N>
pub fn close( &self, descriptor: <ChannelDescriptor as SolType>::RustType, cumulativeAmount: Uint<96, 2>, captureAmount: Uint<96, 2>, signature: Bytes, ) -> CallBuilder<&P, PhantomData<closeCall>, N>
Creates a new call builder for the [close] function.
pub fn requestClose(
&self,
descriptor: <ChannelDescriptor as SolType>::RustType,
) -> CallBuilder<&P, PhantomData<requestCloseCall>, N>
pub fn requestClose( &self, descriptor: <ChannelDescriptor as SolType>::RustType, ) -> CallBuilder<&P, PhantomData<requestCloseCall>, N>
Creates a new call builder for the [requestClose] function.
pub fn withdraw(
&self,
descriptor: <ChannelDescriptor as SolType>::RustType,
) -> CallBuilder<&P, PhantomData<withdrawCall>, N>
pub fn withdraw( &self, descriptor: <ChannelDescriptor as SolType>::RustType, ) -> CallBuilder<&P, PhantomData<withdrawCall>, N>
Creates a new call builder for the [withdraw] function.
pub fn getChannel(
&self,
descriptor: <ChannelDescriptor as SolType>::RustType,
) -> CallBuilder<&P, PhantomData<getChannelCall>, N>
pub fn getChannel( &self, descriptor: <ChannelDescriptor as SolType>::RustType, ) -> CallBuilder<&P, PhantomData<getChannelCall>, N>
Creates a new call builder for the [getChannel] function.
pub fn getChannelState(
&self,
channelId: FixedBytes<32>,
) -> CallBuilder<&P, PhantomData<getChannelStateCall>, N>
pub fn getChannelState( &self, channelId: FixedBytes<32>, ) -> CallBuilder<&P, PhantomData<getChannelStateCall>, N>
Creates a new call builder for the [getChannelState] function.
pub fn getChannelStatesBatch(
&self,
channelIds: Vec<FixedBytes<32>>,
) -> CallBuilder<&P, PhantomData<getChannelStatesBatchCall>, N>
pub fn getChannelStatesBatch( &self, channelIds: Vec<FixedBytes<32>>, ) -> CallBuilder<&P, PhantomData<getChannelStatesBatchCall>, N>
Creates a new call builder for the [getChannelStatesBatch] function.
pub fn computeChannelId(
&self,
payer: Address,
payee: Address,
operator: Address,
token: Address,
salt: FixedBytes<32>,
authorizedSigner: Address,
expiringNonceHash: FixedBytes<32>,
) -> CallBuilder<&P, PhantomData<computeChannelIdCall>, N>
pub fn computeChannelId( &self, payer: Address, payee: Address, operator: Address, token: Address, salt: FixedBytes<32>, authorizedSigner: Address, expiringNonceHash: FixedBytes<32>, ) -> CallBuilder<&P, PhantomData<computeChannelIdCall>, N>
Creates a new call builder for the [computeChannelId] function.
pub fn getVoucherDigest(
&self,
channelId: FixedBytes<32>,
cumulativeAmount: Uint<96, 2>,
) -> CallBuilder<&P, PhantomData<getVoucherDigestCall>, N>
pub fn getVoucherDigest( &self, channelId: FixedBytes<32>, cumulativeAmount: Uint<96, 2>, ) -> CallBuilder<&P, PhantomData<getVoucherDigestCall>, N>
Creates a new call builder for the [getVoucherDigest] function.
pub fn domainSeparator(
&self,
) -> CallBuilder<&P, PhantomData<domainSeparatorCall>, N>
pub fn domainSeparator( &self, ) -> CallBuilder<&P, PhantomData<domainSeparatorCall>, N>
Creates a new call builder for the [domainSeparator] function.
§impl<P, N> ITIP20ChannelReserveInstance<P, N>where
P: Provider<N>,
N: Network,
Event filters.
impl<P, N> ITIP20ChannelReserveInstance<P, N>where
P: Provider<N>,
N: Network,
Event filters.
pub fn event_filter<E>(&self) -> Event<&P, E, N>where
E: SolEvent,
pub fn event_filter<E>(&self) -> Event<&P, E, N>where
E: SolEvent,
Creates a new event filter using this contract instance’s provider and address.
Note that the type can be any event, not just those defined in this contract. Prefer using the other methods for building type-safe event filters.
pub fn ChannelOpened_filter(&self) -> Event<&P, ChannelOpened, N>
pub fn ChannelOpened_filter(&self) -> Event<&P, ChannelOpened, N>
Creates a new event filter for the ChannelOpened event.
pub fn Settled_filter(&self) -> Event<&P, Settled, N>
pub fn Settled_filter(&self) -> Event<&P, Settled, N>
Creates a new event filter for the Settled event.
pub fn TopUp_filter(&self) -> Event<&P, TopUp, N>
pub fn TopUp_filter(&self) -> Event<&P, TopUp, N>
Creates a new event filter for the TopUp event.
pub fn CloseRequested_filter(&self) -> Event<&P, CloseRequested, N>
pub fn CloseRequested_filter(&self) -> Event<&P, CloseRequested, N>
Creates a new event filter for the CloseRequested event.
pub fn ChannelClosed_filter(&self) -> Event<&P, ChannelClosed, N>
pub fn ChannelClosed_filter(&self) -> Event<&P, ChannelClosed, N>
Creates a new event filter for the ChannelClosed event.
pub fn CloseRequestCancelled_filter(
&self,
) -> Event<&P, CloseRequestCancelled, N>
pub fn CloseRequestCancelled_filter( &self, ) -> Event<&P, CloseRequestCancelled, N>
Creates a new event filter for the CloseRequestCancelled event.
Trait Implementations§
§impl<P, N> Clone for ITIP20ChannelReserveInstance<P, N>
impl<P, N> Clone for ITIP20ChannelReserveInstance<P, N>
§fn clone(&self) -> ITIP20ChannelReserveInstance<P, N>
fn clone(&self) -> ITIP20ChannelReserveInstance<P, N>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl<P, N> Freeze for ITIP20ChannelReserveInstance<P, N>where
P: Freeze,
impl<P, N> RefUnwindSafe for ITIP20ChannelReserveInstance<P, N>where
P: RefUnwindSafe,
N: RefUnwindSafe,
impl<P, N> Send for ITIP20ChannelReserveInstance<P, N>
impl<P, N> Sync for ITIP20ChannelReserveInstance<P, N>
impl<P, N> Unpin for ITIP20ChannelReserveInstance<P, N>
impl<P, N> UnsafeUnpin for ITIP20ChannelReserveInstance<P, N>where
P: UnsafeUnpin,
impl<P, N> UnwindSafe for ITIP20ChannelReserveInstance<P, N>where
P: UnwindSafe,
N: UnwindSafe,
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
§impl<T> Conv for T
impl<T> Conv for T
impl<T> ErasedDestructor for Twhere
T: 'static,
§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,
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,
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,
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,
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,
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,
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,
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,
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,
§impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
impl<TxEnv, T> FromRecoveredTx<&T> for TxEnvwhere
TxEnv: FromRecoveredTx<T>,
§fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv
TxEnv from a transaction and a sender address.§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§impl<B> IntoBlock<B> for B
impl<B> IntoBlock<B> for B
§fn into_block(self) -> B
fn into_block(self) -> B
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> ⓘ
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> ⓘ
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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Layered].§impl<D> OwoColorize for D
impl<D> OwoColorize for D
§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg] or
a color-specific method, such as [OwoColorize::green], Read more§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg] or
a color-specific method, such as [OwoColorize::on_yellow], Read more§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self,
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
§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>
renamed to 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,
§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,
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,
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
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
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
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> Read<Exclusive, BecauseExclusive> 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
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
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
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
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
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
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
.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
.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
.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
.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
.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
.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
.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> ⓘ
Layout§
Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.