#[non_exhaustive]pub struct ThingPrincipalObjectBuilder { /* private fields */ }
Expand description
A builder for ThingPrincipalObject
.
Implementations§
Source§impl ThingPrincipalObjectBuilder
impl ThingPrincipalObjectBuilder
Sourcepub fn principal(self, input: impl Into<String>) -> Self
pub fn principal(self, input: impl Into<String>) -> Self
The principal of the thing principal object.
This field is required.Sourcepub fn set_principal(self, input: Option<String>) -> Self
pub fn set_principal(self, input: Option<String>) -> Self
The principal of the thing principal object.
Sourcepub fn get_principal(&self) -> &Option<String>
pub fn get_principal(&self) -> &Option<String>
The principal of the thing principal object.
Sourcepub fn thing_principal_type(self, input: ThingPrincipalType) -> Self
pub fn thing_principal_type(self, input: ThingPrincipalType) -> Self
The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING
.
-
EXCLUSIVE_THING
- Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.
-
NON_EXCLUSIVE_THING
- Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.
Sourcepub fn set_thing_principal_type(self, input: Option<ThingPrincipalType>) -> Self
pub fn set_thing_principal_type(self, input: Option<ThingPrincipalType>) -> Self
The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING
.
-
EXCLUSIVE_THING
- Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.
-
NON_EXCLUSIVE_THING
- Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.
Sourcepub fn get_thing_principal_type(&self) -> &Option<ThingPrincipalType>
pub fn get_thing_principal_type(&self) -> &Option<ThingPrincipalType>
The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING
.
-
EXCLUSIVE_THING
- Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.
-
NON_EXCLUSIVE_THING
- Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.
Sourcepub fn build(self) -> Result<ThingPrincipalObject, BuildError>
pub fn build(self) -> Result<ThingPrincipalObject, BuildError>
Consumes the builder and constructs a ThingPrincipalObject
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ThingPrincipalObjectBuilder
impl Clone for ThingPrincipalObjectBuilder
Source§fn clone(&self) -> ThingPrincipalObjectBuilder
fn clone(&self) -> ThingPrincipalObjectBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ThingPrincipalObjectBuilder
impl Debug for ThingPrincipalObjectBuilder
Source§impl Default for ThingPrincipalObjectBuilder
impl Default for ThingPrincipalObjectBuilder
Source§fn default() -> ThingPrincipalObjectBuilder
fn default() -> ThingPrincipalObjectBuilder
impl StructuralPartialEq for ThingPrincipalObjectBuilder
Auto Trait Implementations§
impl Freeze for ThingPrincipalObjectBuilder
impl RefUnwindSafe for ThingPrincipalObjectBuilder
impl Send for ThingPrincipalObjectBuilder
impl Sync for ThingPrincipalObjectBuilder
impl Unpin for ThingPrincipalObjectBuilder
impl UnwindSafe for ThingPrincipalObjectBuilder
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§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();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§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();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§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();
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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§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);