Skip to main content

GridExtent

Struct GridExtent 

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

A validated grid shape: a non-negative width and height whose product is a cell count the runtime can actually allocate.

This is the only route from a user-supplied Int pair to a cell count. Reaching vec![unit; (w as usize) * (h as usize)] directly would let w = -1 become usize::MAX and the product overflow — either an allocation the host cannot serve (an OOM abort) or a capacity-overflow panic, both crossing extern "C". Neither is expressible here: GridExtent holds usizes, and the multiplication it proves is the one cells() returns.

Implementations§

Source§

impl GridExtent

Source

pub const MAX_CELLS: usize

The largest grid the runtime will construct: 2^28 cells, which is 2 GiB of GcRef storage before a single cell object exists.

A cap, not a checked_mul, because a product that merely fits in a usize is still an allocation no host can serve — Grid[Int](2^40, 2) multiplies cleanly and then aborts the process. The number is a judgement about what a Praxis program plausibly asks for; a program that wants more gets a fault it can see rather than a SIGKILL it cannot.

Source

pub const fn new(width: i64, height: i64) -> Option<GridExtent>

The extent width × height names, or None if either side is negative or the grid would exceed MAX_CELLS.

Source

pub const fn width(self) -> usize

The column count.

Source

pub const fn height(self) -> usize

The row count.

Source

pub const fn cells(self) -> usize

The total cell count — width * height, proven not to overflow.

Trait Implementations§

Source§

impl Clone for GridExtent

Source§

fn clone(&self) -> GridExtent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for GridExtent

Source§

impl Debug for GridExtent

Source§

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

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

impl Eq for GridExtent

Source§

impl PartialEq for GridExtent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GridExtent

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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.