Struct Capture 

pub struct Capture(/* private fields */);

The bytes that a command wrote to one of its streams

The value holds the bytes as the command wrote them. A command writes what it wants: the lines of a report, the bytes of an archive, or a sequence that is not valid UTF-8 at all. A conversion into text would lose the bytes that have no character, so the type keeps the bytes and offers the text to the caller that wants it.

Examples

use kawauso_process::execution::Capture;

let capture = Capture::new("hello\n");

assert_eq!(capture.to_string_lossy().trim(), "hello");

Implementations

impl Capture

pub fn new(bytes: impl Into<Vec<u8>>) -> Self

Creates the capture of a stream from the bytes that a command wrote

Examples

use kawauso_process::execution::Capture;

let capture = Capture::new(vec![b'h', b'i']);

assert_eq!(capture.get(), b"hi");

pub fn get(&self) -> &[u8]

Returns the bytes as the command wrote them

pub fn is_empty(&self) -> bool

Returns whether the command wrote nothing to the stream

pub fn to_string_lossy(&self) -> Cow<'_, str>

Returns the capture as text

A byte that is part of no valid character becomes the replacement character U+FFFD. The text is therefore always valid UTF-8, and a caller that needs the bytes of the command asks for get instead.

Examples

use kawauso_process::execution::Capture;

let capture = Capture::new(vec![0xff]);

assert_eq!(capture.to_string_lossy(), "\u{fffd}");

Trait Implementations

impl Clone for Capture

fn clone(&self) -> Capture

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capture

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

Formats the value using the given formatter.

impl Default for Capture

fn default() -> Capture

Returns the “default value” for a type.

impl Display for Capture

Shows the capture for a reader

The text is the lossy conversion that to_string_lossy returns, because a log line and an error message take text and not bytes.

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

Formats the value using the given formatter.

impl Eq for Capture

impl From<Vec<u8>> for Capture

Creates the capture of a stream from the bytes that a command wrote

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl Hash for Capture

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Capture

fn cmp(&self, other: &Capture) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Capture

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Capture

fn partial_cmp(&self, other: &Capture) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Capture