scryer_prolog::machine::streams

Struct StreamOptions

Source 
pub struct StreamOptions { /* private fields */ }

Implementations§

Source§

impl StreamOptions

Source

pub const fn new() -> Self

Returns an instance with zero initialized data.

Source§

impl StreamOptions

Source

pub const fn into_bytes(self) -> [u8; 8]

Returns the underlying bits.

§Layout

The returned byte array is layed out in the same way as described here.

Source

pub const fn from_bytes(bytes: [u8; 8]) -> Self

Converts the given bytes directly into the bitfield struct.

Source§

impl StreamOptions

Source

pub fn stream_type(&self) -> <StreamType as Specifier>::InOut

Returns the value of stream_type.

Source

pub fn stream_type_or_err( &self, ) -> Result<<StreamType as Specifier>::InOut, InvalidBitPattern<<StreamType as Specifier>::Bytes>>

Returns the value of stream_type.

#Errors

If the returned value contains an invalid bit pattern for stream_type.

Source

pub fn with_stream_type(self, new_val: <StreamType as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of stream_type set to the given value.

#Panics

If the given value is out of bounds for stream_type.

Source

pub fn with_stream_type_checked( self, new_val: <StreamType as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of stream_type set to the given value.

#Errors

If the given value is out of bounds for stream_type.

Source

pub fn set_stream_type(&mut self, new_val: <StreamType as Specifier>::InOut)

Sets the value of stream_type to the given value.

#Panics

If the given value is out of bounds for stream_type.

Source

pub fn set_stream_type_checked( &mut self, new_val: <StreamType as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of stream_type to the given value.

#Errors

If the given value is out of bounds for stream_type.

Source

pub fn reposition(&self) -> <bool as Specifier>::InOut

Returns the value of reposition.

Source

pub fn reposition_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of reposition.

#Errors

If the returned value contains an invalid bit pattern for reposition.

Source

pub fn with_reposition(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of reposition set to the given value.

#Panics

If the given value is out of bounds for reposition.

Source

pub fn with_reposition_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of reposition set to the given value.

#Errors

If the given value is out of bounds for reposition.

Source

pub fn set_reposition(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of reposition to the given value.

#Panics

If the given value is out of bounds for reposition.

Source

pub fn set_reposition_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of reposition to the given value.

#Errors

If the given value is out of bounds for reposition.

Source

pub fn eof_action(&self) -> <EOFAction as Specifier>::InOut

Returns the value of eof_action.

Source

pub fn eof_action_or_err( &self, ) -> Result<<EOFAction as Specifier>::InOut, InvalidBitPattern<<EOFAction as Specifier>::Bytes>>

Returns the value of eof_action.

#Errors

If the returned value contains an invalid bit pattern for eof_action.

Source

pub fn with_eof_action(self, new_val: <EOFAction as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of eof_action set to the given value.

#Panics

If the given value is out of bounds for eof_action.

Source

pub fn with_eof_action_checked( self, new_val: <EOFAction as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of eof_action set to the given value.

#Errors

If the given value is out of bounds for eof_action.

Source

pub fn set_eof_action(&mut self, new_val: <EOFAction as Specifier>::InOut)

Sets the value of eof_action to the given value.

#Panics

If the given value is out of bounds for eof_action.

Source

pub fn set_eof_action_checked( &mut self, new_val: <EOFAction as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of eof_action to the given value.

#Errors

If the given value is out of bounds for eof_action.

Source

pub fn has_alias(&self) -> <bool as Specifier>::InOut

Returns the value of has_alias.

Source

pub fn has_alias_or_err( &self, ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of has_alias.

#Errors

If the returned value contains an invalid bit pattern for has_alias.

Source

pub fn with_has_alias(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of has_alias set to the given value.

#Panics

If the given value is out of bounds for has_alias.

Source

pub fn with_has_alias_checked( self, new_val: <bool as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of has_alias set to the given value.

#Errors

If the given value is out of bounds for has_alias.

Source

pub fn set_has_alias(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of has_alias to the given value.

#Panics

If the given value is out of bounds for has_alias.

Source

pub fn set_has_alias_checked( &mut self, new_val: <bool as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of has_alias to the given value.

#Errors

If the given value is out of bounds for has_alias.

Source

pub fn alias(&self) -> <B59 as Specifier>::InOut

Returns the value of alias.

Source

pub fn alias_or_err( &self, ) -> Result<<B59 as Specifier>::InOut, InvalidBitPattern<<B59 as Specifier>::Bytes>>

Returns the value of alias.

#Errors

If the returned value contains an invalid bit pattern for alias.

Source

pub fn with_alias(self, new_val: <B59 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of alias set to the given value.

#Panics

If the given value is out of bounds for alias.

Source

pub fn with_alias_checked( self, new_val: <B59 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of alias set to the given value.

#Errors

If the given value is out of bounds for alias.

Source

pub fn set_alias(&mut self, new_val: <B59 as Specifier>::InOut)

Sets the value of alias to the given value.

#Panics

If the given value is out of bounds for alias.

Source

pub fn set_alias_checked( &mut self, new_val: <B59 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of alias to the given value.

#Errors

If the given value is out of bounds for alias.

Source§

impl StreamOptions

Source

pub fn get_alias(self) -> Option<Atom>

Source

pub fn set_alias_to_atom_opt(&mut self, alias: Option<Atom>)

Trait Implementations§

Source§

impl CheckTotalSizeMultipleOf8 for StreamOptions

Source§

type Size = TotalSize<[(); 0]>

Source§

impl Clone for StreamOptions

Source§

fn clone(&self) -> StreamOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StreamOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<StreamOptions> for u64
where [(); 64]: IsU64Compatible,

Source§

fn from(__bf_bitfield: StreamOptions) -> Self

Converts to this type from the input type.
Source§

impl From<u64> for StreamOptions
where [(); 64]: IsU64Compatible,

Source§

fn from(__bf_prim: u64) -> Self

Converts to this type from the input type.
Source§

impl Hash for StreamOptions

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for StreamOptions

Source§

fn eq(&self, other: &StreamOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for StreamOptions

Source§

impl Eq for StreamOptions

Source§

impl StructuralPartialEq for StreamOptions

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,