Struct GoalBuilder

Source

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

Expand description

A builder for Goal.

Implementations§

Source §

impl GoalBuilder

Source

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

The unique identifier for the agent space containing this goal This field is required.

Source

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

The unique identifier for the agent space containing this goal

Source

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

The unique identifier for the agent space containing this goal

Source

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

The unique identifier for this goal This field is required.

Source

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

The unique identifier for this goal

Source

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

The unique identifier for this goal

Source

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

The title of the goal This field is required.

Source

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

The title of the goal

Source

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

The title of the goal

Source

pub fn content(self, input: GoalContent) -> Self

Content of the goal This field is required.

Source

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

Content of the goal

Source

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

Content of the goal

Source

pub fn status(self, input: GoalStatus) -> Self

Current status of the goal itself This field is required.

Source

pub fn set_status(self, input: Option<GoalStatus>) -> Self

Current status of the goal itself

Source

pub fn get_status(&self) -> &Option<GoalStatus>

Current status of the goal itself

Source

pub fn goal_type(self, input: GoalType) -> Self

Type of goal based on its origin This field is required.

Source

pub fn set_goal_type(self, input: Option<GoalType>) -> Self

Type of goal based on its origin

Source

pub fn get_goal_type(&self) -> &Option<GoalType>

Type of goal based on its origin

Source

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

Timestamp when this goal was created This field is required.

Source

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

Timestamp when this goal was created

Source

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

Timestamp when this goal was created

Source

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

Timestamp when this goal was last updated This field is required.

Source

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

Timestamp when this goal was last updated

Source

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

Timestamp when this goal was last updated

Source

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

Timestamp when the goal was last evaluated

Source

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

Timestamp when the goal was last evaluated

Source

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

Timestamp when the goal was last evaluated

Source

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

ID of the most recent task associated with this goal

Source

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

ID of the most recent task associated with this goal

Source

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

ID of the most recent task associated with this goal

Source

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

ID of the most recent successful task associated with this goal

Source

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

ID of the most recent successful task associated with this goal

Source

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

ID of the most recent successful task associated with this goal

Source

pub fn version(self, input: i32) -> Self

Version number for optimistic locking This field is required.

Source

pub fn set_version(self, input: Option<i32>) -> Self

Version number for optimistic locking

Source

pub fn get_version(&self) -> &Option<i32>

Version number for optimistic locking

Source

pub fn evaluation_schedule(self, input: GoalSchedule) -> Self

Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily

Source

pub fn set_evaluation_schedule(self, input: Option<GoalSchedule>) -> Self

Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily

Source

pub fn get_evaluation_schedule(&self) -> &Option<GoalSchedule>

Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily

Source

pub fn build(self) -> Result<Goal, BuildError>

Consumes the builder and constructs a Goal. This method will fail if any of the following fields are not set:

Trait Implementations§

Source §

impl Clone for GoalBuilder

Source §

fn clone(&self) -> GoalBuilder

Returns a duplicate 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 GoalBuilder

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for GoalBuilder

Source §

fn default() -> GoalBuilder

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

Source §

impl PartialEq for GoalBuilder

Source §

fn eq(&self, other: &GoalBuilder) -> 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 GoalBuilder

Auto Trait Implementations§

§

impl UnwindSafe for GoalBuilder

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

GoalBuilder

Struct GoalBuilder Copy item path

Implementations§

impl GoalBuilder

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

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

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

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

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

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

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

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

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

pub fn content(self, input: GoalContent) -> Self

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

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

pub fn status(self, input: GoalStatus) -> Self

pub fn set_status(self, input: Option<GoalStatus>) -> Self

pub fn get_status(&self) -> &Option<GoalStatus>

pub fn goal_type(self, input: GoalType) -> Self

pub fn set_goal_type(self, input: Option<GoalType>) -> Self

pub fn get_goal_type(&self) -> &Option<GoalType>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn version(self, input: i32) -> Self

pub fn set_version(self, input: Option<i32>) -> Self

pub fn get_version(&self) -> &Option<i32>

pub fn evaluation_schedule(self, input: GoalSchedule) -> Self

pub fn set_evaluation_schedule(self, input: Option<GoalSchedule>) -> Self

pub fn get_evaluation_schedule(&self) -> &Option<GoalSchedule>

pub fn build(self) -> Result<Goal, BuildError>

Trait Implementations§

impl Clone for GoalBuilder

fn clone(&self) -> GoalBuilder

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

impl Debug for GoalBuilder

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

impl Default for GoalBuilder

fn default() -> GoalBuilder

impl PartialEq for GoalBuilder

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

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

impl StructuralPartialEq for GoalBuilder

Auto Trait Implementations§

impl Freeze for GoalBuilder

impl RefUnwindSafe for GoalBuilder

impl Send for GoalBuilder

impl Sync for GoalBuilder

impl Unpin for GoalBuilder

impl UnsafeUnpin for GoalBuilder

impl UnwindSafe for GoalBuilder

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, dest: *mut u8)

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

Struct GoalBuilder

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,