Enum p8n_types::Region

source ·

pub enum Region {
    Undefined {
        address_bits: usize,
        name: Str,
        uuid: Uuid,
    },
    Buffer {
        address_bits: usize,
        name: Str,
        uuid: Uuid,
        offset: u64,
        buffer: Arc<[u8]>,
    },
    File {
        address_bits: usize,
        name: Str,
        uuid: Uuid,
        offset: u64,
        file: Arc<Mmap>,
        path: Option<PathBuf>,
        file_offset: u64,
    },
}

Expand description

A continuous address space. Regions are an array of cells numbered from 0. Each cell is either undefined of carries a single byte value.

Variants

`Undefined`

Fields

address_bits: usize

Addressable space. All cells in a region have addresses between 0 and 2^address_bits - 1.

name: Str

Human readable name. This name can vary over the livetime of a region and bears no semantic meaning. It’s for use in UIs.

uuid: Uuid

Immutable UUID. The UUID of a region never changes. Can be used for housekeeping and associating additional data with this region.

All undefined values

`Buffer`

Fields

address_bits: usize

Addressable space. All cells in a region have addresses between 0 and 2^address_bits - 1.

name: Str

Human readable name. This name can vary over the livetime of a region and bears no semantic meaning. It’s for use in UIs.

uuid: Uuid

Immutable UUID. The UUID of a region never changes. Can be used for housekeeping and associating additional data with this region.

offset: u64

Positon of the buffer in the address space.

buffer: Arc<[u8]>

Region contents

In memory buffer

`File`

Fields

address_bits: usize

Addressable space. All cells in a region have addresses between 0 and 2^address_bits - 1.

name: Str

Human readable name. This name can vary over the livetime of a region and bears no semantic meaning. It’s for use in UIs.

uuid: Uuid

Immutable UUID. The UUID of a region never changes. Can be used for housekeeping and associating additional data with this region.

offset: u64

Positon of the file in the address space.

file: Arc<Mmap>

mmap()’d file.

path: Option<PathBuf>

Path to the mapped file

file_offset: u64

Start of mapping inside file

Memory mapped file.

Implementations

source

impl Region

source

pub fn undefined<S: Into<Str>>(name: S, address_bits: usize) -> Region

Creates a new completly undefined region with name and address_bits.

source

pub fn from_mmap<S, O, P>(
 name: S,
 address_bits: usize,
 mmap: Mmap,
 path: P,
 file_offset: O,
 offset: O
) -> Regionwhere
 S: Into<Str>,
 O: Into<Option<u64>>,
 P: Into<Option<PathBuf>>,

Creates a new region called name that is address_bits large. Maps mmap to offset.

source

pub fn from_file<S, O, P>(
 name: S,
 address_bits: usize,
 fd: File,
 path: P,
 offset: O
) -> Result<Region>where
 S: Into<Str>,
 O: Into<Option<u64>>,
 P: Into<Option<PathBuf>>,

Creates a new region called name that is address_bits large. Maps fd to offset.

source

pub fn from_buf<S: Into<Str>, O: Into<Option<u64>>, B: Into<Arc<[u8]>>>(
 name: S,
 address_bits: usize,
 buf: B,
 offset: O
) -> Region

Creates a new region called name that is address_bits large. Maps buf to offset.

source

pub fn file<'a>(&'a self) -> Option<(&'a Path, u64)>

If this is a mmap()’d file, return the path to it and mmap() starting position.

source

pub fn name<'a>(&'a self) -> &'a Str

Returns the human readable name of this region.

source

pub fn rename(&mut self, new: Str)

Changes the human readable name to new.

source

pub fn uuid<'a>(&'a self) -> &'a Uuid

Returns the immutable UUID of this region.

source

pub fn address_bits(&self) -> usize

Size of this region.

source

pub fn defined(&self) -> Range<u64>

Defined range

source

pub fn read<'a>(&'a self, start: u64, len: usize) -> Result<&'a [u8]>

Fill buf the the values starting at address. Fails if address..address + buf.len() is outside of the addressable range or contains undefined values.

source

pub fn try_read(&self, address: u64, buf: &mut [u8]) -> Result<usize>

Trys to fill buf the the values starting at address. Returns early if address..address + buf.len() contains undefined values and fails if it’s outside of the addressable range. Returns the number of bytes read.

source

pub fn read_integer(
 &self,
 address: u64,
 endianess: Endianess,
 bytes: usize
) -> Result<u64>

Reads an bytes large integer from address and zero-extends it to an u64. Fails if address..address + bytes is outside of the addressable range or contains undefined values.

source