Struct LispBuffer

pub(crate) struct LispBuffer(GcHeap<LispBufferInner>);

A lisp handle to a buffer. This is a just a reference type and does not give access to the contents until it is locked and a OpenBuffer is returned.

Tuple Fields

0: GcHeap<LispBufferInner>

Implementations

impl LispBuffer

pub(crate) fn create(name: String, block: &Block<true>) -> &LispBuffer

pub(crate) unsafe fn new(name: String, _: &Block<true>) -> LispBuffer

pub(in core) fn lock( &self, ) -> Result<OpenBuffer<'_>>

impl<'new> LispBuffer

pub(in core) fn clone_in<const C: bool>( &self, _: &'new Block<C>, ) -> Gc<&'new LispBuffer>

Methods from Deref<Target = <GcHeap<LispBufferInner> as std_ops_Deref>::Target>

const NULL: *mut u8 = {0x0 as *mut u8}

const EMTPTY: AtomicPtr<u8> = _

fn header(&self) -> &GcHeader

pub(in core) fn forward( &self, fwd_ptr: NonNull<u8>, )

pub(in core) fn allocation_state( &self, ) -> AllocState

fn is_marked(&self) -> bool

Trait Implementations

impl Markable for LispBuffer

type Value = NonNull<LispBuffer>

fn move_value(&self, to_space: &Bump) -> Option<(Self::Value, bool)>

impl PartialEq<LispBuffer> for CurrentBuffer<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<LispBuffer> for OpenBuffer<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OpenBuffer<'_>> for LispBuffer

fn eq(&self, other: &OpenBuffer<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for LispBuffer

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RootedDeref for LispBuffer

type Target = RootedLispBuffer

fn rooted_deref(rooted: &Rt<Self>) -> &Self::Target

fn rooted_derefmut(rooted: &mut Rt<Self>) -> &mut Self::Target

impl TaggedPtr for &LispBuffer

const TAG: Tag = Tag::Buffer

Tag value. This is only applicable to base values. Use Int for sum types.

type Ptr = LispBuffer

The type of object being pointed to. This will be different for all implementors.

unsafe fn from_obj_ptr(ptr: *const u8) -> Self

Given an untyped pointer, reinterpret to self.

fn get_ptr(self) -> *const Self::Ptr

Get the underlying pointer.

unsafe fn tag_ptr(ptr: *const Self::Ptr) -> Gc<Self>

Given a pointer to Ptr return a Tagged pointer.

fn untag(val: Gc<Self>) -> Self

Remove the tag from the Gc<T> and return the inner type. If it is base type then it will only have a single possible value and can be untagged without checks, but sum types need to create all values they can hold. We use tagged base types to let us reinterpret bits without actually modify them.

fn tag(self) -> Gc<Self>

Given the type, return a tagged version of it. When using a sum type or an immediate value like i64, we override this method to set the proper tag.

impl Trace for LispBuffer

fn trace(&self, state: &mut GcState)

impl<'old, 'new> WithLifetime<'new> for &'old LispBuffer

type Out = &'new LispBuffer

unsafe fn with_lifetime(self) -> Self::Out

impl<'ob> From<&'ob LispBuffer> for Gc<ObjectType<'ob>>

fn from(x: &'ob LispBuffer) -> Self

Converts to this type from the input type.

impl Debug for LispBuffer

fn fmt(&self, f: &mut std_fmt_Formatter<'_>) -> std_fmt_Result

Formats the value using the given formatter.

impl Display for LispBuffer

fn fmt(&self, f: &mut std_fmt_Formatter<'_>) -> std_fmt_Result

Formats the value using the given formatter.

impl Deref for LispBuffer

type Target = <GcHeap<LispBufferInner> as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for LispBuffer

impl GcPtr for &LispBuffer

impl StructuralPartialEq for LispBuffer