SegmentMut

Struct SegmentMut 

Source
pub struct SegmentMut { /* private fields */ }
Expand description

Mutable view into a region of a memory-mapped file. Holds a reference to the parent map; mutable access is provided on demand.

§Examples

use std::sync::Arc;
use mmap_io::{MemoryMappedFile, segment::SegmentMut};

let mmap = Arc::new(MemoryMappedFile::create_rw("data.bin", 1024)?);

// Create a mutable segment for bytes 0-100
let segment = SegmentMut::new(mmap.clone(), 0, 100)?;

// Write data to the segment
segment.write(b"Hello from segment!")?;

Implementations§

Source§

impl SegmentMut

Source

pub fn new(parent: Arc<MemoryMappedFile>, offset: u64, len: u64) -> Result<Self>

Create a new mutable segment view. Performs bounds checks.

§Errors

Returns MmapIoError::OutOfBounds if the segment exceeds file bounds.

Source

pub fn as_slice_mut(&self) -> Result<MappedSliceMut<'_>>

Return a write-capable guard to the underlying bytes for this segment. The guard holds the write lock for the duration of the mutable borrow.

§Errors

Returns errors from the underlying MemoryMappedFile::as_slice_mut call.

Note: Bounds are already validated at construction, so as_slice_mut will not perform redundant validation.

Source

pub fn write(&self, data: &[u8]) -> Result<()>

Write bytes into this segment from the provided slice.

§Errors

Returns errors from the underlying MemoryMappedFile::update_region call.

Source

pub fn len(&self) -> u64

Length of the segment.

Source

pub fn is_empty(&self) -> bool

Check if the segment is empty.

Source

pub fn offset(&self) -> u64

Offset of the segment in the file.

Source

pub fn parent(&self) -> &MemoryMappedFile

Parent mapping.

Trait Implementations§

Source§

impl Clone for SegmentMut

Source§

fn clone(&self) -> SegmentMut

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 SegmentMut

Source§

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

Formats the value using the given formatter. Read more

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