Struct swipl::stream::ReadablePrologStream

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

A stream from prolog that can be read from.

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> ReadablePrologStream<'a>

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

Wrap a readable prolog stream.

Safety

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

pub fn encoding(&self) -> StreamEncoding

pub fn decoding_reader(self) -> Either<Self, Latin1Reader<Self>>

Returns an implementation of Read which will automatically decode the underlying prolog stream, ensuring that it looks like proper utf-8.

This is especially useful for cases where we like to pass a reader to a decoder like serde.

Trait Implementations

impl<'a> Drop for ReadablePrologStream<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Read for ReadablePrologStream<'a>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<'a> TermGetable for ReadablePrologStream<'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.