Struct ChannelMessageBuilder

source

#[non_exhaustive]
pub struct ChannelMessageBuilder { /* private fields */ }

Expand description

A builder for ChannelMessage.

Implementations§

source §

impl ChannelMessageBuilder

source

pub fn channel_arn(self, input: impl Into<String>) -> Self

The ARN of the channel.

source

pub fn set_channel_arn(self, input: Option<String>) -> Self

The ARN of the channel.

source

pub fn get_channel_arn(&self) -> &Option<String>

The ARN of the channel.

source

pub fn message_id(self, input: impl Into<String>) -> Self

The ID of a message.

source

pub fn set_message_id(self, input: Option<String>) -> Self

The ID of a message.

source

pub fn get_message_id(&self) -> &Option<String>

The ID of a message.

source

pub fn content(self, input: impl Into<String>) -> Self

The message content.

source

pub fn set_content(self, input: Option<String>) -> Self

The message content.

source

pub fn get_content(&self) -> &Option<String>

The message content.

source

pub fn metadata(self, input: impl Into<String>) -> Self

The message metadata.

source

pub fn set_metadata(self, input: Option<String>) -> Self

The message metadata.

source

pub fn get_metadata(&self) -> &Option<String>

The message metadata.

source

pub fn type(self, input: ChannelMessageType) -> Self

The message type.

source

pub fn set_type(self, input: Option<ChannelMessageType>) -> Self

The message type.

source

pub fn get_type(&self) -> &Option<ChannelMessageType>

The message type.

source

pub fn created_timestamp(self, input: DateTime) -> Self

The time at which the message was created.

source

pub fn set_created_timestamp(self, input: Option<DateTime>) -> Self

The time at which the message was created.

source

pub fn get_created_timestamp(&self) -> &Option<DateTime>

The time at which the message was created.

source

pub fn last_edited_timestamp(self, input: DateTime) -> Self

The time at which a message was edited.

source

pub fn set_last_edited_timestamp(self, input: Option<DateTime>) -> Self

The time at which a message was edited.

source

pub fn get_last_edited_timestamp(&self) -> &Option<DateTime>

The time at which a message was edited.

source

pub fn last_updated_timestamp(self, input: DateTime) -> Self

The time at which a message was updated.

source

pub fn set_last_updated_timestamp(self, input: Option<DateTime>) -> Self

The time at which a message was updated.

source

pub fn get_last_updated_timestamp(&self) -> &Option<DateTime>

The time at which a message was updated.

source

pub fn sender(self, input: Identity) -> Self

The message sender.

source

pub fn set_sender(self, input: Option<Identity>) -> Self

The message sender.

source

pub fn get_sender(&self) -> &Option<Identity>

The message sender.

source

pub fn redacted(self, input: bool) -> Self

Hides the content of a message.

source

pub fn set_redacted(self, input: Option<bool>) -> Self

Hides the content of a message.

source

pub fn get_redacted(&self) -> &Option<bool>

Hides the content of a message.

source

pub fn persistence(self, input: ChannelMessagePersistenceType) -> Self

The persistence setting for a channel message.

source

pub fn set_persistence( self, input: Option<ChannelMessagePersistenceType>, ) -> Self

The persistence setting for a channel message.

source

pub fn get_persistence(&self) -> &Option<ChannelMessagePersistenceType>

The persistence setting for a channel message.

source

pub fn build(self) -> ChannelMessage

Consumes the builder and constructs a ChannelMessage.

Trait Implementations§

source §

impl Clone for ChannelMessageBuilder

source §

fn clone(&self) -> ChannelMessageBuilder

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

source §

impl Debug for ChannelMessageBuilder

source §

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

Formats the value using the given formatter. Read more

source §

impl Default for ChannelMessageBuilder

source §

fn default() -> ChannelMessageBuilder

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

source §

impl PartialEq for ChannelMessageBuilder

source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

source §

impl StructuralPartialEq for ChannelMessageBuilder

Auto Trait Implementations§

§

impl UnwindSafe for ChannelMessageBuilder

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. 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 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> 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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source §

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

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

source §

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

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

§Example

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

source §

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

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> Same for T

source §

type Output = T

Should always be Self

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, U> TryFrom 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>::Error>

Performs the conversion.

source §

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

source §

type Error = >::Error

The type returned in the event of a conversion error.

source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

Struct ChannelMessageBuilderCopy item path

Implementations§

impl ChannelMessageBuilder

pub fn channel_arn(self, input: impl Into<String>) -> Self

pub fn set_channel_arn(self, input: Option<String>) -> Self

pub fn get_channel_arn(&self) -> &Option<String>

pub fn message_id(self, input: impl Into<String>) -> Self

pub fn set_message_id(self, input: Option<String>) -> Self

pub fn get_message_id(&self) -> &Option<String>

pub fn content(self, input: impl Into<String>) -> Self

pub fn set_content(self, input: Option<String>) -> Self

pub fn get_content(&self) -> &Option<String>

pub fn metadata(self, input: impl Into<String>) -> Self

pub fn set_metadata(self, input: Option<String>) -> Self

pub fn get_metadata(&self) -> &Option<String>

pub fn type(self, input: ChannelMessageType) -> Self

pub fn set_type(self, input: Option<ChannelMessageType>) -> Self

pub fn get_type(&self) -> &Option<ChannelMessageType>

pub fn created_timestamp(self, input: DateTime) -> Self

pub fn set_created_timestamp(self, input: Option<DateTime>) -> Self

pub fn get_created_timestamp(&self) -> &Option<DateTime>

pub fn last_edited_timestamp(self, input: DateTime) -> Self

pub fn set_last_edited_timestamp(self, input: Option<DateTime>) -> Self

pub fn get_last_edited_timestamp(&self) -> &Option<DateTime>

pub fn last_updated_timestamp(self, input: DateTime) -> Self

pub fn set_last_updated_timestamp(self, input: Option<DateTime>) -> Self

pub fn get_last_updated_timestamp(&self) -> &Option<DateTime>

pub fn sender(self, input: Identity) -> Self

pub fn set_sender(self, input: Option<Identity>) -> Self

pub fn get_sender(&self) -> &Option<Identity>

pub fn redacted(self, input: bool) -> Self

pub fn set_redacted(self, input: Option<bool>) -> Self

pub fn get_redacted(&self) -> &Option<bool>

pub fn persistence(self, input: ChannelMessagePersistenceType) -> Self

pub fn set_persistence( self, input: Option<ChannelMessagePersistenceType>, ) -> Self

pub fn get_persistence(&self) -> &Option<ChannelMessagePersistenceType>

pub fn build(self) -> ChannelMessage

Trait Implementations§

impl Clone for ChannelMessageBuilder

fn clone(&self) -> ChannelMessageBuilder

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

impl Debug for ChannelMessageBuilder

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

impl Default for ChannelMessageBuilder

fn default() -> ChannelMessageBuilder

impl PartialEq for ChannelMessageBuilder

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

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

impl StructuralPartialEq for ChannelMessageBuilder

Auto Trait Implementations§

impl Freeze for ChannelMessageBuilder

impl RefUnwindSafe for ChannelMessageBuilder

impl Send for ChannelMessageBuilder

impl Sync for ChannelMessageBuilder

impl Unpin for ChannelMessageBuilder

impl UnwindSafe for ChannelMessageBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

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

impl<Unshared, Shared> IntoShared<Shared> for Unsharedwhere Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

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

fn fg(&self, value: Color) -> Painted<&T>

§Example

Struct ChannelMessageBuilder

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

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

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

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

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

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

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

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