Skip to main content

Notifiers

stoat::notifiers

Struct Notifiers 

Source 
pub struct Notifiers { /* private fields */ }
Expand description

Notifiers allow you to create temporary event collectors, this is useful to for example wait for a user to send a message as a followup.

Every notifier waits for an event which passes its check which is returned or until the timeout is reached, returning Error::Timeout

Implementations§

Source§

impl Notifiers

Source

pub async fn wait_for_event<F: Fn(&EventV1) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<EventV1, Error>

Waits for the event event to be received.

Source

pub async fn invoke_event_waiters(&self, arg: &EventV1)

Invokes the event event.

Source

pub async fn clear_event_waiters(&self)

Clears all waiters for the event event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_authenticated<F: Fn(&()) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(), Error>

Waits for the authenticated event to be received.

Source

pub async fn invoke_authenticated_waiters(&self, arg: &())

Invokes the authenticated event.

Source

pub async fn clear_authenticated_waiters(&self)

Clears all waiters for the authenticated event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_logout<F: Fn(&()) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(), Error>

Waits for the logout event to be received.

Source

pub async fn invoke_logout_waiters(&self, arg: &())

Invokes the logout event.

Source

pub async fn clear_logout_waiters(&self)

Clears all waiters for the logout event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_pong<F: Fn(&Ping) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Ping, Error>

Waits for the pong event to be received.

Source

pub async fn invoke_pong_waiters(&self, arg: &Ping)

Invokes the pong event.

Source

pub async fn clear_pong_waiters(&self)

Clears all waiters for the pong event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_ready<F: Fn(&()) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(), Error>

Waits for the ready event to be received.

Source

pub async fn invoke_ready_waiters(&self, arg: &())

Invokes the ready event.

Source

pub async fn clear_ready_waiters(&self)

Clears all waiters for the ready event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_message<F: Fn(&Message) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Message, Error>

Waits for the message event to be received.

Source

pub async fn invoke_message_waiters(&self, arg: &Message)

Invokes the message event.

Source

pub async fn clear_message_waiters(&self)

Clears all waiters for the message event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_message_update<F: Fn(&(Message, Message, PartialMessage, Vec<FieldsMessage>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Message, Message, PartialMessage, Vec<FieldsMessage>), Error>

Waits for the message_update event to be received.

Source

pub async fn invoke_message_update_waiters( &self, arg: &(Message, Message, PartialMessage, Vec<FieldsMessage>), )

Invokes the message_update event.

Source

pub async fn clear_message_update_waiters(&self)

Clears all waiters for the message_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_message_delete<F: Fn(&Message) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Message, Error>

Waits for the message_delete event to be received.

Source

pub async fn invoke_message_delete_waiters(&self, arg: &Message)

Invokes the message_delete event.

Source

pub async fn clear_message_delete_waiters(&self)

Clears all waiters for the message_delete event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_message_react<F: Fn(&(Message, String, String)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Message, String, String), Error>

Waits for the message_react event to be received.

Source

pub async fn invoke_message_react_waiters( &self, arg: &(Message, String, String), )

Invokes the message_react event.

Source

pub async fn clear_message_react_waiters(&self)

Clears all waiters for the message_react event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_message_unreact<F: Fn(&(Message, String, String)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Message, String, String), Error>

Waits for the message_unreact event to be received.

Source

pub async fn invoke_message_unreact_waiters( &self, arg: &(Message, String, String), )

Invokes the message_unreact event.

Source

pub async fn clear_message_unreact_waiters(&self)

Clears all waiters for the message_unreact event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_message_remove_reaction<F: Fn(&(Message, String, IndexSet<String>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Message, String, IndexSet<String>), Error>

Waits for the message_remove_reaction event to be received.

Source

pub async fn invoke_message_remove_reaction_waiters( &self, arg: &(Message, String, IndexSet<String>), )

Invokes the message_remove_reaction event.

Source

pub async fn clear_message_remove_reaction_waiters(&self)

Clears all waiters for the message_remove_reaction event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_message_append<F: Fn(&(Message, Vec<Embed>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Message, Vec<Embed>), Error>

Waits for the message_append event to be received.

Source

pub async fn invoke_message_append_waiters(&self, arg: &(Message, Vec<Embed>))

Invokes the message_append event.

Source

pub async fn clear_message_append_waiters(&self)

Clears all waiters for the message_append event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_user_update<F: Fn(&(User, User, PartialUser, Vec<FieldsUser>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(User, User, PartialUser, Vec<FieldsUser>), Error>

Waits for the user_update event to be received.

Source

pub async fn invoke_user_update_waiters( &self, arg: &(User, User, PartialUser, Vec<FieldsUser>), )

Invokes the user_update event.

Source

pub async fn clear_user_update_waiters(&self)

Clears all waiters for the user_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_bulk_message_delete<F: Fn(&(String, Vec<String>, Vec<Message>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, Vec<String>, Vec<Message>), Error>

Waits for the bulk_message_delete event to be received.

Source

pub async fn invoke_bulk_message_delete_waiters( &self, arg: &(String, Vec<String>, Vec<Message>), )

Invokes the bulk_message_delete event.

Source

pub async fn clear_bulk_message_delete_waiters(&self)

Clears all waiters for the bulk_message_delete event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_channel_create<F: Fn(&Channel) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Channel, Error>

Waits for the channel_create event to be received.

Source

pub async fn invoke_channel_create_waiters(&self, arg: &Channel)

Invokes the channel_create event.

Source

pub async fn clear_channel_create_waiters(&self)

Clears all waiters for the channel_create event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_channel_update<F: Fn(&(Channel, Channel, PartialChannel, Vec<FieldsChannel>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Channel, Channel, PartialChannel, Vec<FieldsChannel>), Error>

Waits for the channel_update event to be received.

Source

pub async fn invoke_channel_update_waiters( &self, arg: &(Channel, Channel, PartialChannel, Vec<FieldsChannel>), )

Invokes the channel_update event.

Source

pub async fn clear_channel_update_waiters(&self)

Clears all waiters for the channel_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_channel_delete<F: Fn(&Channel) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Channel, Error>

Waits for the channel_delete event to be received.

Source

pub async fn invoke_channel_delete_waiters(&self, arg: &Channel)

Invokes the channel_delete event.

Source

pub async fn clear_channel_delete_waiters(&self)

Clears all waiters for the channel_delete event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_channel_group_user_join<F: Fn(&(Channel, String)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Channel, String), Error>

Waits for the channel_group_user_join event to be received.

Source

pub async fn invoke_channel_group_user_join_waiters( &self, arg: &(Channel, String), )

Invokes the channel_group_user_join event.

Source

pub async fn clear_channel_group_user_join_waiters(&self)

Clears all waiters for the channel_group_user_join event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_channel_group_user_leave<F: Fn(&(Channel, String)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Channel, String), Error>

Waits for the channel_group_user_leave event to be received.

Source

pub async fn invoke_channel_group_user_leave_waiters( &self, arg: &(Channel, String), )

Invokes the channel_group_user_leave event.

Source

pub async fn clear_channel_group_user_leave_waiters(&self)

Clears all waiters for the channel_group_user_leave event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_create<F: Fn(&(Server, Vec<Channel>, Vec<Emoji>, Vec<ChannelVoiceState>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Server, Vec<Channel>, Vec<Emoji>, Vec<ChannelVoiceState>), Error>

Waits for the server_create event to be received.

Source

pub async fn invoke_server_create_waiters( &self, arg: &(Server, Vec<Channel>, Vec<Emoji>, Vec<ChannelVoiceState>), )

Invokes the server_create event.

Source

pub async fn clear_server_create_waiters(&self)

Clears all waiters for the server_create event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_delete<F: Fn(&(Server, Vec<Channel>, Vec<Emoji>, Vec<ChannelVoiceState>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Server, Vec<Channel>, Vec<Emoji>, Vec<ChannelVoiceState>), Error>

Waits for the server_delete event to be received.

Source

pub async fn invoke_server_delete_waiters( &self, arg: &(Server, Vec<Channel>, Vec<Emoji>, Vec<ChannelVoiceState>), )

Invokes the server_delete event.

Source

pub async fn clear_server_delete_waiters(&self)

Clears all waiters for the server_delete event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_update<F: Fn(&(Server, Server, PartialServer, Vec<FieldsServer>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Server, Server, PartialServer, Vec<FieldsServer>), Error>

Waits for the server_update event to be received.

Source

pub async fn invoke_server_update_waiters( &self, arg: &(Server, Server, PartialServer, Vec<FieldsServer>), )

Invokes the server_update event.

Source

pub async fn clear_server_update_waiters(&self)

Clears all waiters for the server_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_typing_start<F: Fn(&(String, String)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, String), Error>

Waits for the typing_start event to be received.

Source

pub async fn invoke_typing_start_waiters(&self, arg: &(String, String))

Invokes the typing_start event.

Source

pub async fn clear_typing_start_waiters(&self)

Clears all waiters for the typing_start event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_typing_stop<F: Fn(&(String, String)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, String), Error>

Waits for the typing_stop event to be received.

Source

pub async fn invoke_typing_stop_waiters(&self, arg: &(String, String))

Invokes the typing_stop event.

Source

pub async fn clear_typing_stop_waiters(&self)

Clears all waiters for the typing_stop event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_member_join<F: Fn(&Member) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Member, Error>

Waits for the server_member_join event to be received.

Source

pub async fn invoke_server_member_join_waiters(&self, arg: &Member)

Invokes the server_member_join event.

Source

pub async fn clear_server_member_join_waiters(&self)

Clears all waiters for the server_member_join event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_member_leave<F: Fn(&(Member, RemovalIntention)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Member, RemovalIntention), Error>

Waits for the server_member_leave event to be received.

Source

pub async fn invoke_server_member_leave_waiters( &self, arg: &(Member, RemovalIntention), )

Invokes the server_member_leave event.

Source

pub async fn clear_server_member_leave_waiters(&self)

Clears all waiters for the server_member_leave event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_member_update<F: Fn(&(Member, Member, PartialMember, Vec<FieldsMember>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(Member, Member, PartialMember, Vec<FieldsMember>), Error>

Waits for the server_member_update event to be received.

Source

pub async fn invoke_server_member_update_waiters( &self, arg: &(Member, Member, PartialMember, Vec<FieldsMember>), )

Invokes the server_member_update event.

Source

pub async fn clear_server_member_update_waiters(&self)

Clears all waiters for the server_member_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_role_create<F: Fn(&(String, Role)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, Role), Error>

Waits for the server_role_create event to be received.

Source

pub async fn invoke_server_role_create_waiters(&self, arg: &(String, Role))

Invokes the server_role_create event.

Source

pub async fn clear_server_role_create_waiters(&self)

Clears all waiters for the server_role_create event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_role_update<F: Fn(&(String, Role, Role, PartialRole, Vec<FieldsRole>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, Role, Role, PartialRole, Vec<FieldsRole>), Error>

Waits for the server_role_update event to be received.

Source

pub async fn invoke_server_role_update_waiters( &self, arg: &(String, Role, Role, PartialRole, Vec<FieldsRole>), )

Invokes the server_role_update event.

Source

pub async fn clear_server_role_update_waiters(&self)

Clears all waiters for the server_role_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_role_delete<F: Fn(&(String, Role)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, Role), Error>

Waits for the server_role_delete event to be received.

Source

pub async fn invoke_server_role_delete_waiters(&self, arg: &(String, Role))

Invokes the server_role_delete event.

Source

pub async fn clear_server_role_delete_waiters(&self)

Clears all waiters for the server_role_delete event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_server_role_ranks_update<F: Fn(&(String, Vec<Role>, Vec<Role>)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, Vec<Role>, Vec<Role>), Error>

Waits for the server_role_ranks_update event to be received.

Source

pub async fn invoke_server_role_ranks_update_waiters( &self, arg: &(String, Vec<Role>, Vec<Role>), )

Invokes the server_role_ranks_update event.

Source

pub async fn clear_server_role_ranks_update_waiters(&self)

Clears all waiters for the server_role_ranks_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_user_voice_state_update<F: Fn(&(UserVoiceState, UserVoiceState, PartialUserVoiceState)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(UserVoiceState, UserVoiceState, PartialUserVoiceState), Error>

Waits for the user_voice_state_update event to be received.

Source

pub async fn invoke_user_voice_state_update_waiters( &self, arg: &(UserVoiceState, UserVoiceState, PartialUserVoiceState), )

Invokes the user_voice_state_update event.

Source

pub async fn clear_user_voice_state_update_waiters(&self)

Clears all waiters for the user_voice_state_update event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_user_voice_channel_join<F: Fn(&(String, UserVoiceState)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, UserVoiceState), Error>

Waits for the user_voice_channel_join event to be received.

Source

pub async fn invoke_user_voice_channel_join_waiters( &self, arg: &(String, UserVoiceState), )

Invokes the user_voice_channel_join event.

Source

pub async fn clear_user_voice_channel_join_waiters(&self)

Clears all waiters for the user_voice_channel_join event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_user_voice_channel_move<F: Fn(&(String, String, String, UserVoiceState, UserVoiceState)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, String, String, UserVoiceState, UserVoiceState), Error>

Waits for the user_voice_channel_move event to be received.

Source

pub async fn invoke_user_voice_channel_move_waiters( &self, arg: &(String, String, String, UserVoiceState, UserVoiceState), )

Invokes the user_voice_channel_move event.

Source

pub async fn clear_user_voice_channel_move_waiters(&self)

Clears all waiters for the user_voice_channel_move event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_user_voice_channel_leave<F: Fn(&(String, UserVoiceState)) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<(String, UserVoiceState), Error>

Waits for the user_voice_channel_leave event to be received.

Source

pub async fn invoke_user_voice_channel_leave_waiters( &self, arg: &(String, UserVoiceState), )

Invokes the user_voice_channel_leave event.

Source

pub async fn clear_user_voice_channel_leave_waiters(&self)

Clears all waiters for the user_voice_channel_leave event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_emoji_create<F: Fn(&Emoji) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Emoji, Error>

Waits for the emoji_create event to be received.

Source

pub async fn invoke_emoji_create_waiters(&self, arg: &Emoji)

Invokes the emoji_create event.

Source

pub async fn clear_emoji_create_waiters(&self)

Clears all waiters for the emoji_create event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn wait_for_emoji_delete<F: Fn(&Emoji) -> bool + Send + Sync + 'static>( &self, check: F, timeout: Option<Duration>, ) -> Result<Emoji, Error>

Waits for the emoji_delete event to be received.

Source

pub async fn invoke_emoji_delete_waiters(&self, arg: &Emoji)

Invokes the emoji_delete event.

Source

pub async fn clear_emoji_delete_waiters(&self)

Clears all waiters for the emoji_delete event, this will cause them to return Error::BrokenChannel early.

Source

pub async fn clear_all_waiters(&self)

Clears all waiters for all events, this will cause them to return Error::BrokenChannel early.

Trait Implementations§

Source§

impl<E: From<Error> + Clone + Debug + Send + Sync + 'static, S: Debug + Clone + Send + Sync + 'static> AsRef<Notifiers> for Context<E, S>

Source§

fn as_ref(&self) -> &Notifiers

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

impl AsRef<Notifiers> for Context

Source§

fn as_ref(&self) -> &Notifiers

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

impl AsRef<Notifiers> for Notifiers

Source§

fn as_ref(&self) -> &Notifiers

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

impl Clone for Notifiers

Source§

fn clone(&self) -> Notifiers

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Notifiers

Source§

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

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

impl Default for Notifiers

Source§

fn default() -> Notifiers

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoCollection<T> for T

Source§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
Source§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

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

Source§

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();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more