Struct PipeWriter

Source
pub struct PipeWriter(/* private fields */);
๐Ÿ”ฌThis is a nightly-only experimental API. (anonymous_pipe)
Expand description

Write end of an anonymous pipe.

Implementationsยง

Sourceยง

impl PipeWriter

Source

pub fn try_clone(&self) -> Result<PipeWriter, Error>

๐Ÿ”ฌThis is a nightly-only experimental API. (anonymous_pipe)

Create a new PipeWriter instance that shares the same underlying file description.

ยงExamples
#![feature(anonymous_pipe)]
use std::process::Command;
use std::io::{pipe, Read};
let (mut reader, writer) = pipe()?;

// Spawn a process that writes to stdout and stderr.
let mut peer = Command::new("bash")
    .args([
        "-c",
        "echo -n foo\n\
         echo -n bar >&2"
    ])
    .stdout(writer.try_clone()?)
    .stderr(writer)
    .spawn()?;

// Read and check the result.
let mut msg = String::new();
reader.read_to_string(&mut msg)?;
assert_eq!(&msg, "foobar");

peer.wait()?;

Trait Implementationsยง

Sourceยง

impl AsFd for PipeWriter

Sourceยง

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor. Read more
Sourceยง

impl AsRawFd for PipeWriter

Sourceยง

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor. Read more
Sourceยง

impl Debug for PipeWriter

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl From<OwnedFd> for PipeWriter

Sourceยง

fn from(owned_fd: OwnedFd) -> PipeWriter โ“˜

Converts to this type from the input type.
Sourceยง

impl FromRawFd for PipeWriter

Sourceยง

unsafe fn from_raw_fd(raw_fd: i32) -> PipeWriter โ“˜

Constructs a new instance of Self from the given raw file descriptor. Read more
Sourceยง

impl IntoRawFd for PipeWriter

Sourceยง

fn into_raw_fd(self) -> i32

Consumes this object, returning the raw underlying file descriptor. Read more
Sourceยง

impl Write for &PipeWriter

Sourceยง

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Writes a buffer into this writer, returning how many bytes were written. Read more
Sourceยง

fn flush(&mut self) -> Result<(), Error>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Sourceยง

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Sourceยง

fn is_write_vectored(&self) -> bool

๐Ÿ”ฌThis is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 ยท Sourceยง

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
Sourceยง

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

๐Ÿ”ฌThis is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 ยท Sourceยง

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 ยท Sourceยง

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a โ€œby referenceโ€ adapter for this instance of Write. Read more
Sourceยง

impl Write for PipeWriter

Sourceยง

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Writes a buffer into this writer, returning how many bytes were written. Read more
Sourceยง

fn flush(&mut self) -> Result<(), Error>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Sourceยง

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Sourceยง

fn is_write_vectored(&self) -> bool

๐Ÿ”ฌThis is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 ยท Sourceยง

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
Sourceยง

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

๐Ÿ”ฌThis is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 ยท Sourceยง

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 ยท Sourceยง

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a โ€œby referenceโ€ adapter for this instance of Write. Read more

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.

Sourceยง

impl<T> Instrument for T

Sourceยง

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

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> IntoCollection<T> for T

Sourceยง

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
Sourceยง

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

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
Sourceยง

impl<Stream> IsTerminal for Stream
where Stream: AsFd,

Sourceยง

fn is_terminal(&self) -> bool

Returns true if this is a terminal. Read more
Sourceยง

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

Sourceยง

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

ยงExample
println!("{}", value.primary());
Sourceยง

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

ยงExample
println!("{}", value.fixed(color));
Sourceยง

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

ยงExample
println!("{}", value.rgb(r, g, b));
Sourceยง

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

ยงExample
println!("{}", value.black());
Sourceยง

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

ยงExample
println!("{}", value.red());
Sourceยง

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

ยงExample
println!("{}", value.green());
Sourceยง

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

ยงExample
println!("{}", value.yellow());
Sourceยง

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

ยงExample
println!("{}", value.blue());
Sourceยง

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

ยงExample
println!("{}", value.magenta());
Sourceยง

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

ยงExample
println!("{}", value.cyan());
Sourceยง

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

ยงExample
println!("{}", value.white());
Sourceยง

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

ยงExample
println!("{}", value.bright_black());
Sourceยง

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

ยงExample
println!("{}", value.bright_red());
Sourceยง

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

ยงExample
println!("{}", value.bright_green());
Sourceยง

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

ยงExample
println!("{}", value.bright_yellow());
Sourceยง

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

ยงExample
println!("{}", value.bright_blue());
Sourceยง

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

ยงExample
println!("{}", value.bright_magenta());
Sourceยง

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

ยงExample
println!("{}", value.bright_cyan());
Sourceยง

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

ยงExample
println!("{}", value.bright_white());
Sourceยง

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>

Returns self with the bg() set to Color::Primary.

ยงExample
println!("{}", value.on_primary());
Sourceยง

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

ยงExample
println!("{}", value.on_fixed(color));
Sourceยง

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

ยงExample
println!("{}", value.on_rgb(r, g, b));
Sourceยง

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

ยงExample
println!("{}", value.on_black());
Sourceยง

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

ยงExample
println!("{}", value.on_red());
Sourceยง

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

ยงExample
println!("{}", value.on_green());
Sourceยง

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

ยงExample
println!("{}", value.on_yellow());
Sourceยง

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

ยงExample
println!("{}", value.on_blue());
Sourceยง

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

ยงExample
println!("{}", value.on_magenta());
Sourceยง

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

ยงExample
println!("{}", value.on_cyan());
Sourceยง

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

ยงExample
println!("{}", value.on_white());
Sourceยง

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

ยงExample
println!("{}", value.on_bright_black());
Sourceยง

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

ยงExample
println!("{}", value.on_bright_red());
Sourceยง

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

ยงExample
println!("{}", value.on_bright_green());
Sourceยง

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

ยงExample
println!("{}", value.on_bright_yellow());
Sourceยง

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

ยงExample
println!("{}", value.on_bright_blue());
Sourceยง

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

ยงExample
println!("{}", value.on_bright_magenta());
Sourceยง

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

ยงExample
println!("{}", value.on_bright_cyan());
Sourceยง

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

ยงExample
println!("{}", value.on_bright_white());
Sourceยง

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

ยงExample
println!("{}", value.bold());
Sourceยง

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

ยงExample
println!("{}", value.dim());
Sourceยง

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

ยงExample
println!("{}", value.italic());
Sourceยง

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

ยงExample
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

ยงExample
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

ยงExample
println!("{}", value.rapid_blink());
Sourceยง

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

ยงExample
println!("{}", value.invert());
Sourceยง

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

ยงExample
println!("{}", value.conceal());
Sourceยง

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

ยงExample
println!("{}", value.strike());
Sourceยง

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

ยงExample
println!("{}", value.mask());
Sourceยง

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

ยงExample
println!("{}", value.wrap());
Sourceยง

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

ยงExample
println!("{}", value.linger());
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.

Returns self with the quirk() set to Quirk::Clear.

ยงExample
println!("{}", value.clear());
Sourceยง

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

ยงExample
println!("{}", value.resetting());
Sourceยง

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

ยงExample
println!("{}", value.bright());
Sourceยง

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

ยงExample
println!("{}", value.on_bright());
Sourceยง

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);
Sourceยง

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Sourceยง

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Sourceยง

impl<T> Pointable for T

Sourceยง

const ALIGN: usize

The alignment of pointer.
Sourceยง

type Init = T

The type for initializers.
Sourceยง

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

Initializes a with the given initializer. Read more
Sourceยง

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

Dereferences the given pointer. Read more
Sourceยง

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

Mutably dereferences the given pointer. Read more
Sourceยง

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Sourceยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

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
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self> โ“˜

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