#[non_exhaustive]pub struct OrderSummary {
pub outpost_id: Option<String>,
pub order_id: Option<String>,
pub order_type: Option<OrderType>,
pub status: Option<OrderStatus>,
pub line_item_counts_by_status: Option<HashMap<LineItemStatus, i32>>,
pub order_submission_date: Option<DateTime>,
pub order_fulfilled_date: Option<DateTime>,
}
Expand description
A summary of line items in your order.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.outpost_id: Option<String>
The ID of the Outpost.
order_id: Option<String>
The ID of the order.
order_type: Option<OrderType>
The type of order.
status: Option<OrderStatus>
The status of the order.
-
PREPARING
- Order is received and is being prepared. -
IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status. -
COMPLETED
- Order is complete. -
CANCELLED
- Order is cancelled. -
ERROR
- Customer should contact support.
The following statuses are deprecated: RECEIVED
, PENDING
, PROCESSING
, INSTALLING
, and FULFILLED
.
line_item_counts_by_status: Option<HashMap<LineItemStatus, i32>>
The status of all line items in the order.
order_submission_date: Option<DateTime>
The submission date for the order.
order_fulfilled_date: Option<DateTime>
The fulfilment date for the order.
Implementations§
Source§impl OrderSummary
impl OrderSummary
Sourcepub fn outpost_id(&self) -> Option<&str>
pub fn outpost_id(&self) -> Option<&str>
The ID of the Outpost.
Sourcepub fn order_type(&self) -> Option<&OrderType>
pub fn order_type(&self) -> Option<&OrderType>
The type of order.
Sourcepub fn status(&self) -> Option<&OrderStatus>
pub fn status(&self) -> Option<&OrderStatus>
The status of the order.
-
PREPARING
- Order is received and is being prepared. -
IN_PROGRESS
- Order is either being built, shipped, or installed. For more information, see theLineItem
status. -
COMPLETED
- Order is complete. -
CANCELLED
- Order is cancelled. -
ERROR
- Customer should contact support.
The following statuses are deprecated: RECEIVED
, PENDING
, PROCESSING
, INSTALLING
, and FULFILLED
.
Sourcepub fn line_item_counts_by_status(
&self,
) -> Option<&HashMap<LineItemStatus, i32>>
pub fn line_item_counts_by_status( &self, ) -> Option<&HashMap<LineItemStatus, i32>>
The status of all line items in the order.
Sourcepub fn order_submission_date(&self) -> Option<&DateTime>
pub fn order_submission_date(&self) -> Option<&DateTime>
The submission date for the order.
Sourcepub fn order_fulfilled_date(&self) -> Option<&DateTime>
pub fn order_fulfilled_date(&self) -> Option<&DateTime>
The fulfilment date for the order.
Source§impl OrderSummary
impl OrderSummary
Sourcepub fn builder() -> OrderSummaryBuilder
pub fn builder() -> OrderSummaryBuilder
Creates a new builder-style object to manufacture OrderSummary
.
Trait Implementations§
Source§impl Clone for OrderSummary
impl Clone for OrderSummary
Source§fn clone(&self) -> OrderSummary
fn clone(&self) -> OrderSummary
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OrderSummary
impl Debug for OrderSummary
Source§impl PartialEq for OrderSummary
impl PartialEq for OrderSummary
impl StructuralPartialEq for OrderSummary
Auto Trait Implementations§
impl Freeze for OrderSummary
impl RefUnwindSafe for OrderSummary
impl Send for OrderSummary
impl Sync for OrderSummary
impl Unpin for OrderSummary
impl UnwindSafe for OrderSummary
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);