Struct rustler::types::binary::OwnedBinary

pub struct OwnedBinary(_);

An mutable smart-pointer to an Erlang binary.

See module-level doc for more information.

Implementations

impl<'a> OwnedBinary

pub unsafe fn from_raw(inner: ErlNifBinary) -> OwnedBinary

pub fn new(size: usize) -> Option<OwnedBinary>

Allocates a new OwnedBinary with size size.

Memory is not initialized. If uninitialized memory is undesirable, set it manually.

Errors

If allocation fails, None is returned.

pub fn from_unowned(src: &Binary<'_>) -> Option<OwnedBinary>

Copies src’s data into a new OwnedBinary.

Errors

If allocation fails, None is returned.

pub fn realloc(&mut self, size: usize) -> bool

Attempts to reallocate self with the new size.

Memory outside the range of the original binary will not be initialized. If uninitialized memory is undesirable, set it manually.

Errors

If reallocation fails, false is returned. Data remains intact on error.

pub fn realloc_or_copy(&mut self, size: usize)

Attempts to reallocate self with the new size.

If reallocation fails, it will perform a copy instead.

Memory outside the range of the original binary will not be initialized. If uninitialized memory is undesirable, set it manually.

pub fn as_slice(&self) -> &[u8]

Extracts a slice containing the entire binary.

pub fn as_mut_slice(&mut self) -> &mut [u8]

Extracts a mutable slice of the entire binary.

pub fn release(self, env: Env<'_>) -> Binary<'_>

Consumes self and returns an immutable Binary.

This method is the mirror of Binary::from_owned, and they can be used interchangeably.

Trait Implementations

impl Borrow<[u8]> for OwnedBinary

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl BorrowMut<[u8]> for OwnedBinary

fn borrow_mut(&mut self) -> &mut [u8]

Mutably borrows from an owned value.

impl Deref for OwnedBinary

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl DerefMut for OwnedBinary

fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.

impl Drop for OwnedBinary

fn drop(&mut self)

Executes the destructor for this type.

impl Send for OwnedBinary