Skip to main content

ObjFlags

Struct ObjFlags 

Source
pub struct ObjFlags(/* private fields */);
Expand description

Packed object metadata (1 byte).

Layout:

  • Bits 0-2: access level (0-4)
  • Bit 3: executable (0=literal, 1=executable)
  • Bit 4: global (0=local, 1=global)
  • Bit 5: composite (0=simple, 1=composite)

Implementations§

Source§

impl ObjFlags

Source

pub const LITERAL: u8 = 0

Source

pub const EXECUTABLE: u8

Source

pub const ACCESS_NONE: u8 = 0

Source

pub const ACCESS_EXECUTE_ONLY: u8 = 1

Source

pub const ACCESS_READ_ONLY: u8 = 2

Source

pub const ACCESS_WRITE_ONLY: u8 = 3

Source

pub const ACCESS_UNLIMITED: u8 = 4

Source

pub fn new(access: u8, executable: bool, global: bool, composite: bool) -> Self

Create new flags with specified attributes.

Source

pub fn literal() -> Self

Convenience: literal simple object with unlimited access.

Source

pub fn executable() -> Self

Convenience: executable simple object with unlimited access.

Source

pub fn literal_composite() -> Self

Convenience: literal composite object with unlimited access.

Source

pub fn executable_composite() -> Self

Convenience: executable composite object with unlimited access.

Source

pub fn access(self) -> u8

Source

pub fn is_executable(self) -> bool

Source

pub fn is_literal(self) -> bool

Source

pub fn is_global(self) -> bool

Source

pub fn is_composite(self) -> bool

Source

pub fn set_executable(&mut self)

Source

pub fn set_literal(&mut self)

Source

pub fn set_access(&mut self, access: u8)

Source

pub fn is_deferred(self) -> bool

Check if this object is deferred (should be pushed to o_stack from e_stack).

Used by exec_procedure to mark nested executable arrays that should be pushed to the operand stack rather than executed when encountered on the execution stack. The executable flag remains set so operators like if and ifelse still accept them.

Source

pub fn set_deferred(&mut self)

Mark this object as deferred.

Source

pub fn clear_deferred(&mut self)

Clear the deferred flag.

Source

pub fn require_read(self) -> Result<(), PsError>

Require read access (>= READ_ONLY). Returns InvalidAccess if not.

Source

pub fn require_write(self) -> Result<(), PsError>

Require write access (>= UNLIMITED) for non-file composites. Returns InvalidAccess if not.

Source

pub fn require_file_write(self) -> Result<(), PsError>

Require file write access (>= WRITE_ONLY). Returns InvalidAccess if not.

Trait Implementations§

Source§

impl Clone for ObjFlags

Source§

fn clone(&self) -> ObjFlags

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 ObjFlags

Source§

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

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

impl PartialEq for ObjFlags

Source§

fn eq(&self, other: &ObjFlags) -> 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 ObjFlags

Source§

impl Eq for ObjFlags

Source§

impl StructuralPartialEq for ObjFlags

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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, 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.