#[non_exhaustive]pub struct DeviceBuilder { /* private fields */ }
Expand description
A builder for Device
.
Implementations§
Source§impl DeviceBuilder
impl DeviceBuilder
Sourcepub fn connector_device_id(self, input: impl Into<String>) -> Self
pub fn connector_device_id(self, input: impl Into<String>) -> Self
The device id as defined by the connector.
This parameter is used for cloud-to-cloud devices only.
Sourcepub fn set_connector_device_id(self, input: Option<String>) -> Self
pub fn set_connector_device_id(self, input: Option<String>) -> Self
The device id as defined by the connector.
This parameter is used for cloud-to-cloud devices only.
Sourcepub fn get_connector_device_id(&self) -> &Option<String>
pub fn get_connector_device_id(&self) -> &Option<String>
The device id as defined by the connector.
This parameter is used for cloud-to-cloud devices only.
Sourcepub fn connector_device_name(self, input: impl Into<String>) -> Self
pub fn connector_device_name(self, input: impl Into<String>) -> Self
The name of the device as defined by the connector.
Sourcepub fn set_connector_device_name(self, input: Option<String>) -> Self
pub fn set_connector_device_name(self, input: Option<String>) -> Self
The name of the device as defined by the connector.
Sourcepub fn get_connector_device_name(&self) -> &Option<String>
pub fn get_connector_device_name(&self) -> &Option<String>
The name of the device as defined by the connector.
Sourcepub fn capability_report(self, input: MatterCapabilityReport) -> Self
pub fn capability_report(self, input: MatterCapabilityReport) -> Self
The capability report for the device.
This field is required.Sourcepub fn set_capability_report(
self,
input: Option<MatterCapabilityReport>,
) -> Self
pub fn set_capability_report( self, input: Option<MatterCapabilityReport>, ) -> Self
The capability report for the device.
Sourcepub fn get_capability_report(&self) -> &Option<MatterCapabilityReport>
pub fn get_capability_report(&self) -> &Option<MatterCapabilityReport>
The capability report for the device.
Sourcepub fn capability_schemas(self, input: CapabilitySchemaItem) -> Self
pub fn capability_schemas(self, input: CapabilitySchemaItem) -> Self
Appends an item to capability_schemas
.
To override the contents of this collection use set_capability_schemas
.
Report of all capabilities supported by the device.
Sourcepub fn set_capability_schemas(
self,
input: Option<Vec<CapabilitySchemaItem>>,
) -> Self
pub fn set_capability_schemas( self, input: Option<Vec<CapabilitySchemaItem>>, ) -> Self
Report of all capabilities supported by the device.
Sourcepub fn get_capability_schemas(&self) -> &Option<Vec<CapabilitySchemaItem>>
pub fn get_capability_schemas(&self) -> &Option<Vec<CapabilitySchemaItem>>
Report of all capabilities supported by the device.
Sourcepub fn device_metadata(self, input: Document) -> Self
pub fn device_metadata(self, input: Document) -> Self
The metadata attributes for a device.
Sourcepub fn set_device_metadata(self, input: Option<Document>) -> Self
pub fn set_device_metadata(self, input: Option<Document>) -> Self
The metadata attributes for a device.
Sourcepub fn get_device_metadata(&self) -> &Option<Document>
pub fn get_device_metadata(&self) -> &Option<Document>
The metadata attributes for a device.
Trait Implementations§
Source§impl Clone for DeviceBuilder
impl Clone for DeviceBuilder
Source§fn clone(&self) -> DeviceBuilder
fn clone(&self) -> DeviceBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DeviceBuilder
impl Debug for DeviceBuilder
Source§impl Default for DeviceBuilder
impl Default for DeviceBuilder
Source§fn default() -> DeviceBuilder
fn default() -> DeviceBuilder
Source§impl PartialEq for DeviceBuilder
impl PartialEq for DeviceBuilder
impl StructuralPartialEq for DeviceBuilder
Auto Trait Implementations§
impl Freeze for DeviceBuilder
impl RefUnwindSafe for DeviceBuilder
impl Send for DeviceBuilder
impl Sync for DeviceBuilder
impl Unpin for DeviceBuilder
impl UnwindSafe for DeviceBuilder
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);