Skip to main content

OutputAssert

Struct OutputAssert 

pub struct OutputAssert {
    output: Output,
    config: Assert,
}
Expand description

Assert the state of a Command’s Output.

Create an OutputAssert through the Command::assert.

Fields§

§output: Output§config: Assert

Implementations§

§

impl OutputAssert

pub fn new(output: Output) -> OutputAssert

Create an Assert for a given Output.

pub fn with_assert(self, config: Assert) -> OutputAssert

Customize the assertion behavior

pub fn get_output(&self) -> &Output

Access the contained Output.

pub fn success(self) -> OutputAssert

Ensure the command succeeded.

use snapbox::cmd::Command;
use snapbox::cmd::cargo_bin;

let assert = Command::new(cargo_bin("snap-fixture"))
    .assert()
    .success();

pub fn failure(self) -> OutputAssert

Ensure the command failed.

use snapbox::cmd::Command;
use snapbox::cmd::cargo_bin;

let assert = Command::new(cargo_bin("snap-fixture"))
    .env("exit", "1")
    .assert()
    .failure();

pub fn interrupted(self) -> OutputAssert

Ensure the command aborted before returning a code.

pub fn code(self, expected: i32) -> OutputAssert

Ensure the command returned the expected code.

use snapbox::cmd::Command;
use snapbox::cmd::cargo_bin;

let assert = Command::new(cargo_bin("snap-fixture"))
    .env("exit", "42")
    .assert()
    .code(42);

pub fn stdout_eq(self, expected: impl IntoData) -> OutputAssert

Ensure the command wrote the expected data to stdout.

By default filters are applied, including:

  • ... is a line-wildcard when on a line by itself
  • [..] is a character-wildcard when inside a line
  • [EXE] matches .exe on Windows
  • "{...}" is a JSON value wildcard
  • "...": "{...}" is a JSON key-value wildcard
  • \ to /
  • Newlines

To limit this to newline normalization for text, call Data::raw on expected.

§Examples
use snapbox::cmd::Command;
use snapbox::cmd::cargo_bin;

let assert = Command::new(cargo_bin("snap-fixture"))
    .env("stdout", "hello")
    .env("stderr", "world")
    .assert()
    .stdout_eq("he[..]o");

Can combine this with file!

use snapbox::cmd::Command;
use snapbox::cmd::cargo_bin;
use snapbox::file;

let assert = Command::new(cargo_bin("snap-fixture"))
    .env("stdout", "hello")
    .env("stderr", "world")
    .assert()
    .stdout_eq(file!["stdout.log"]);

pub fn stdout_eq_(self, expected: impl IntoData) -> OutputAssert

👎Deprecated since 0.6.0:

Replaced with OutputAssert::stdout_eq

pub fn stderr_eq(self, expected: impl IntoData) -> OutputAssert

Ensure the command wrote the expected data to stderr.

By default filters are applied, including:

  • ... is a line-wildcard when on a line by itself
  • [..] is a character-wildcard when inside a line
  • [EXE] matches .exe on Windows
  • "{...}" is a JSON value wildcard
  • "...": "{...}" is a JSON key-value wildcard
  • \ to /
  • Newlines

To limit this to newline normalization for text, call Data::raw on expected.

§Examples
use snapbox::cmd::Command;
use snapbox::cmd::cargo_bin;

let assert = Command::new(cargo_bin("snap-fixture"))
    .env("stdout", "hello")
    .env("stderr", "world")
    .assert()
    .stderr_eq("wo[..]d");

Can combine this with file!

use snapbox::cmd::Command;
use snapbox::cmd::cargo_bin;
use snapbox::file;

let assert = Command::new(cargo_bin("snap-fixture"))
    .env("stdout", "hello")
    .env("stderr", "world")
    .assert()
    .stderr_eq(file!["stderr.log"]);

pub fn stderr_eq_(self, expected: impl IntoData) -> OutputAssert

👎Deprecated since 0.6.0:

Replaced with OutputAssert::stderr_eq

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 232 bytes