Struct basic_text::TextWriter [−][src]
pub struct TextWriter<Inner> { /* fields omitted */ }
Expand description
A WriteLayered
implementation which translates to an output
WriteLayered
producing a valid Basic Text stream from an arbitrary
byte sequence.
write
is not guaranteed to perform a single operation, because short
writes could produce invalid UTF-8, so write
will retry as needed.
Implementations
impl<Inner: WriteStr + WriteLayered> TextWriter<Inner>
[src]
impl<Inner: WriteStr + WriteLayered> TextWriter<Inner>
[src]pub fn with_bom_compatibility(inner: Inner) -> Result<Self>
[src]
pub fn with_bom_compatibility(inner: Inner) -> Result<Self>
[src]Like new
, but writes a U+FEFF (BOM) to the beginning of the output
stream for compatibility with consumers that require that to determine
the text encoding.
pub fn with_crlf_compatibility(inner: Inner) -> Self
[src]
pub fn with_crlf_compatibility(inner: Inner) -> Self
[src]Like new
, but enables CRLF output mode, which translates “\n” to
“\r\n” for compatibility with consumers that need that.
Note: This is not often needed; even on Windows these days most things are ok with plain ‘\n’ line endings, including Windows Notepad. The main notable things that really need them are IETF RFCs, for example RFC-5198.
pub fn close_into_inner(self) -> Result<Inner>
[src]
pub fn close_into_inner(self) -> Result<Inner>
[src]Flush and close the underlying stream and return the underlying stream object.
pub fn abandon_into_inner(self) -> Inner
[src]
pub fn abandon_into_inner(self) -> Inner
[src]Return the underlying stream object.
Trait Implementations
impl<Inner: WriteStr + WriteLayered + AsRawFd> AsRawFd for TextWriter<Inner>
[src]
impl<Inner: WriteStr + WriteLayered + AsRawFd> AsRawFd for TextWriter<Inner>
[src]impl<Inner: WriteStr + WriteLayered> Bufferable for TextWriter<Inner>
[src]
impl<Inner: WriteStr + WriteLayered> Bufferable for TextWriter<Inner>
[src]fn suggested_buffer_size(&self) -> usize
[src]
fn suggested_buffer_size(&self) -> usize
[src]A suggested size, in bytes, for buffering for performance.
impl<Inner: Debug> Debug for TextWriter<Inner>
[src]
impl<Inner: Debug> Debug for TextWriter<Inner>
[src]impl<Inner: WriteStr + WriteLayered> Write for TextWriter<Inner>
[src]
impl<Inner: WriteStr + WriteLayered> Write for TextWriter<Inner>
[src]fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]Write a buffer into this writer, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
fn flush(&mut self) -> Result<()>
[src]Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn is_write_vectored(&self) -> bool
[src]
fn is_write_vectored(&self) -> bool
[src]can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>
[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>
[src]write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]Attempts to write an entire buffer into this writer. Read more
impl<Inner: WriteStr + WriteLayered> WriteLayered for TextWriter<Inner>
[src]
impl<Inner: WriteStr + WriteLayered> WriteLayered for TextWriter<Inner>
[src]impl<Inner: WriteStr + WriteLayered> WriteStr for TextWriter<Inner>
[src]
impl<Inner: WriteStr + WriteLayered> WriteStr for TextWriter<Inner>
[src]impl<Inner: WriteStr + WriteLayered> WriteText for TextWriter<Inner>
[src]
impl<Inner: WriteStr + WriteLayered> WriteText for TextWriter<Inner>
[src]fn write_text(&mut self, s: &TextStr) -> Result<()>
[src]
fn write_text(&mut self, s: &TextStr) -> Result<()>
[src]Like WriteStr::write_str
but writes from a TextStr
.
impl<Inner: OwnsRaw> OwnsRaw for TextWriter<Inner>
[src]
Auto Trait Implementations
impl<Inner> RefUnwindSafe for TextWriter<Inner> where
Inner: RefUnwindSafe,
Inner: RefUnwindSafe,
impl<Inner> Send for TextWriter<Inner> where
Inner: Send,
Inner: Send,
impl<Inner> Sync for TextWriter<Inner> where
Inner: Sync,
Inner: Sync,
impl<Inner> Unpin for TextWriter<Inner> where
Inner: Unpin,
Inner: Unpin,
impl<Inner> UnwindSafe for TextWriter<Inner> where
Inner: UnwindSafe,
Inner: UnwindSafe,
Blanket Implementations
impl<T> AsUnsafeFile for T where
T: AsRawFd + OwnsRaw,
[src]
impl<T> AsUnsafeFile for T where
T: AsRawFd + OwnsRaw,
[src]pub fn as_unsafe_file(&self) -> UnsafeFile
[src]
pub fn as_unsafe_file(&self) -> UnsafeFile
[src]Return the contained unsafe file.
fn as_file_view(&self) -> View<'_, File>
[src]
fn as_file_view(&self) -> View<'_, File>
[src]Utility for returning a value which dereferences to a &File
or
&mut File
. Read more
unsafe fn as_unscoped_file_view(&self) -> View<'static, File>
[src]
unsafe fn as_unscoped_file_view(&self) -> View<'static, File>
[src]Like as_file_view
, but returns a value which is not explicitly tied
to the lifetime of self
. Read more
fn as_pipe_reader_view(&self) -> View<'_, PipeReader>
[src]
fn as_pipe_reader_view(&self) -> View<'_, PipeReader>
[src]Utility for returning a value which dereferences to a &PipeReader
or
&mut PipeReader
. Read more
unsafe fn as_unscoped_pipe_reader_view(&self) -> View<'static, PipeReader>
[src]
unsafe fn as_unscoped_pipe_reader_view(&self) -> View<'static, PipeReader>
[src]Like as_pipe_reader_view
, but returns a value which is not explicitly
tied to the lifetime of self
. Read more
fn as_pipe_writer_view(&self) -> View<'_, PipeWriter>
[src]
fn as_pipe_writer_view(&self) -> View<'_, PipeWriter>
[src]Utility for returning a value which dereferences to a &PipeWriter
or
&mut PipeWriter
. Read more
unsafe fn as_unscoped_pipe_writer_view(&self) -> View<'static, PipeWriter>
[src]
unsafe fn as_unscoped_pipe_writer_view(&self) -> View<'static, PipeWriter>
[src]Like as_pipe_writer_view
, but returns a value which is not explicitly
tied to the lifetime of self
. Read more
impl<T> AsUnsafeHandle for T where
T: AsRawFd + OwnsRaw,
[src]
impl<T> AsUnsafeHandle for T where
T: AsRawFd + OwnsRaw,
[src]pub fn as_unsafe_handle(&self) -> UnsafeHandle
[src]
pub fn as_unsafe_handle(&self) -> UnsafeHandle
[src]Return the contained unsafe handle.
impl<T> AsUnsafeSocket for T where
T: AsRawFd + OwnsRaw,
[src]
impl<T> AsUnsafeSocket for T where
T: AsRawFd + OwnsRaw,
[src]pub fn as_unsafe_socket(&self) -> UnsafeSocket
[src]
pub fn as_unsafe_socket(&self) -> UnsafeSocket
[src]Return the contained unsafe socket.
fn as_tcp_stream_view(&self) -> View<'_, TcpStream>
[src]
fn as_tcp_stream_view(&self) -> View<'_, TcpStream>
[src]Utility for returning a value which dereferences to a &TcpStream
or
&mut TcpStream
. Read more
unsafe fn as_unscoped_tcp_stream_view(&self) -> View<'static, TcpStream>
[src]
unsafe fn as_unscoped_tcp_stream_view(&self) -> View<'static, TcpStream>
[src]Like as_tcp_stream_view
, but returns a value which is not explicitly
tied to the lifetime of self
. Read more
fn as_tcp_listener_view(&self) -> View<'_, TcpListener>
[src]
fn as_tcp_listener_view(&self) -> View<'_, TcpListener>
[src]Utility for returning a value which dereferences to a &TcpListener
or
&mut TcpListener
. Read more
unsafe fn as_unscoped_tcp_listener_view(&self) -> View<'static, TcpListener>
[src]
unsafe fn as_unscoped_tcp_listener_view(&self) -> View<'static, TcpListener>
[src]Like as_tcp_listener_view
, but returns a value which is not
explicitly tied to the lifetime of self
. Read more
fn as_udp_socket_view(&self) -> View<'_, UdpSocket>
[src]
fn as_udp_socket_view(&self) -> View<'_, UdpSocket>
[src]Utility for returning a value which dereferences to a &UdpSocket
or
&mut UdpSocket
. Read more
unsafe fn as_unscoped_udp_socket_view(&self) -> View<'static, UdpSocket>
[src]
unsafe fn as_unscoped_udp_socket_view(&self) -> View<'static, UdpSocket>
[src]Like as_udp_socket_view
, but returns a value which is not explicitly
tied to the lifetime of self
. Read more
fn as_unix_stream_view(&self) -> View<'_, UnixStream>
[src]
fn as_unix_stream_view(&self) -> View<'_, UnixStream>
[src]Utility for returning a value which dereferences to a &UnixStream
or
&mut UnixStream
. Read more
unsafe fn as_unscoped_unix_stream_view(&self) -> View<'static, UnixStream>
[src]
unsafe fn as_unscoped_unix_stream_view(&self) -> View<'static, UnixStream>
[src]Like as_unix_stream_view
, but returns a value which is not explicitly
tied to the lifetime of self
. Read more
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more