pub struct Sink { /* private fields */ }Expand description
An output being written; see the module documentation.
Implementations§
Source§impl Sink
impl Sink
Sourcepub fn create(target: &Target, compression: OutputCompression) -> Result<Self>
pub fn create(target: &Target, compression: OutputCompression) -> Result<Self>
Opens target for writing with the given compression.
§Errors
DimaError::Io if the temporary file (or the destination) cannot be created.
Sourcepub fn create_cancellable(
target: &Target,
compression: OutputCompression,
cancel: Option<Arc<AtomicBool>>,
) -> Result<Self>
pub fn create_cancellable( target: &Target, compression: OutputCompression, cancel: Option<Arc<AtomicBool>>, ) -> Result<Self>
Sink::create with a cancellation flag: once it is set, the next write that reaches
the destination fails with DimaError::Cancelled.
§Errors
As Sink::create.
Sourcepub fn error(&self, e: Error) -> DimaError
pub fn error(&self, e: Error) -> DimaError
Wraps a write error with the destination (DimaError::Cancelled after a
cancellation).
Trait Implementations§
Source§impl Write for Sink
impl Write for Sink
Source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Writes a buffer into this writer, returning how many bytes were written. Read more
Source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flushes this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
Source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector)1.0.0 · Source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
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>
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
Auto Trait Implementations§
impl !UnwindSafe for Sink
impl Freeze for Sink
impl RefUnwindSafe for Sink
impl Send for Sink
impl Sync for Sink
impl Unpin for Sink
impl UnsafeUnpin for Sink
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
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> 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> ⓘ
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 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> ⓘ
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