pub struct AttachmentBuilder<'a> { /* private fields */ }Expand description
A Type that knows how to construct an Attachment.
Implementations§
Source§impl<'a> AttachmentBuilder<'a>
impl<'a> AttachmentBuilder<'a>
Sourcepub fn usage_type(self, val: &'a str) -> Result<Self, DataError>
pub fn usage_type(self, val: &'a str) -> Result<Self, DataError>
Set the usage_type field.
Raise DataError if the input string is empty or when parsed as an IRI yields an invalid value.
Sourcepub fn display(
self,
tag: &MyLanguageTag,
label: &str,
) -> Result<Self, DataError>
pub fn display( self, tag: &MyLanguageTag, label: &str, ) -> Result<Self, DataError>
Add label tagged by the language tag to the display dictionary.
Raise DataError if the tag was empty or invalid.
Sourcepub fn with_display(self, map: LanguageMap) -> Result<Self, DataError>
pub fn with_display(self, map: LanguageMap) -> Result<Self, DataError>
Set (as in replace) the display property for the instance being built
w/ the one passed as argument.
Sourcepub fn description(
self,
tag: &MyLanguageTag,
label: &str,
) -> Result<Self, DataError>
pub fn description( self, tag: &MyLanguageTag, label: &str, ) -> Result<Self, DataError>
Add label tagged by the language tag to the description dictionary.
Raise DataError if the tag was empty or invalid.
Sourcepub fn with_description(self, map: LanguageMap) -> Result<Self, DataError>
pub fn with_description(self, map: LanguageMap) -> Result<Self, DataError>
Set (as in replace) the description property for the instance being built
w/ the one passed as argument.
Sourcepub fn content_type(self, val: &str) -> Result<Self, DataError>
pub fn content_type(self, val: &str) -> Result<Self, DataError>
Set the content_type field.
Raise DataError if the input string is empty, or is not a valid MIME type string.
Sourcepub fn sha2(self, val: &'a str) -> Result<Self, DataError>
pub fn sha2(self, val: &'a str) -> Result<Self, DataError>
Set the sha2 field.
Raise DataError if the input string is empty, has the wrong number of characters, or contains non-hexadecimal characters.
Sourcepub fn file_url(self, val: &'a str) -> Result<Self, DataError>
pub fn file_url(self, val: &'a str) -> Result<Self, DataError>
Set the file_url field.
Raise DataError if the input string is empty, an error occurs while parsing it as an IRI, or the resulting IRI is an invalid URL.
Sourcepub fn build(&self) -> Result<Attachment, DataError>
pub fn build(&self) -> Result<Attachment, DataError>
Create an Attachment instance from set field values.
Raise a DataError if any required field is missing.
Trait Implementations§
Source§impl<'a> Debug for AttachmentBuilder<'a>
impl<'a> Debug for AttachmentBuilder<'a>
Source§impl<'a> Default for AttachmentBuilder<'a>
impl<'a> Default for AttachmentBuilder<'a>
Source§fn default() -> AttachmentBuilder<'a>
fn default() -> AttachmentBuilder<'a>
Auto Trait Implementations§
impl<'a> Freeze for AttachmentBuilder<'a>
impl<'a> RefUnwindSafe for AttachmentBuilder<'a>
impl<'a> Send for AttachmentBuilder<'a>
impl<'a> Sync for AttachmentBuilder<'a>
impl<'a> Unpin for AttachmentBuilder<'a>
impl<'a> UnwindSafe for AttachmentBuilder<'a>
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> 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> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
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);