Struct swipl::stream::WritablePrologStream

pub struct WritablePrologStream<'a> { /* private fields */ }

A stream from prolog that can be directly written to.

This stream will be in a claimed state, meaning, any attempted handling of this stream from another (prolog) thread will fail. On drop, this claim will be released. It is therefore important to drop this stream as soon as possible.

Implementations

impl<'a> WritablePrologStream<'a>

pub unsafe fn new(stream: *mut IOSTREAM) -> WritablePrologStream<'a>

Wrap a writable prolog stream.

Safety

This is only safe to do with actual IOSTREAMs coming out of SWI-Prolog, which are writable.

pub fn encoding(&self) -> StreamEncoding

Trait Implementations

impl<'a> Drop for WritablePrologStream<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> TermGetable for WritablePrologStream<'a>

fn get(term: &Term<'_>) -> Option<Self>

Get data from a term reference.

fn name() -> &'static str

Get the name of this data type for use in exception reporting.

impl<'a> Write for WritablePrologStream<'a>

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

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

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.

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

Attempts to write an entire buffer into this writer.

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.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.