Skip to main content

MemoryBudgets

Struct MemoryBudgets 

Source
#[non_exhaustive]
pub struct MemoryBudgets { pub max_input_bytes: u64, pub max_buffered_input_bytes: u64, pub max_output_bytes: u64, pub max_channels: u32, pub max_metadata_bytes: u64, pub max_index_entries: u32, pub max_box_depth: u32, pub max_workspace_bytes: u64, pub max_declared_au_bytes: u32, }
Expand description

Named memory limits. Default is the speech-ingest set.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§max_input_bytes: u64§max_buffered_input_bytes: u64§max_output_bytes: u64§max_channels: u32§max_metadata_bytes: u64§max_index_entries: u32§max_box_depth: u32§max_workspace_bytes: u64§max_declared_au_bytes: u32

Implementations§

Source§

impl MemoryBudgets

Source

pub fn unbounded_collection() -> Self

Same fences as Default, but collected PCM uses u64::MAX / 2 so an unbounded-duration one-shot still cannot wrap the byte count.

Source

pub fn validate(&self) -> Result<(), BudgetExceeded>

Zero in any field disables the fence; reject that like TASK-21.

Source

pub fn check_input_finite(&self, len: u64) -> Result<usize, BudgetExceeded>

Source

pub fn check_buffered(&self, buffered: u64) -> Result<usize, BudgetExceeded>

Source

pub fn check_declared_au(&self, len: u64) -> Result<usize, BudgetExceeded>

Source

pub fn check_channels(&self, n: u32) -> Result<(), BudgetExceeded>

Source

pub fn check_output( &self, channels: u32, samples: u64, ) -> Result<usize, BudgetExceeded>

Source

pub fn check_index( &self, entries: u64, bytes_per_entry: u64, ) -> Result<usize, BudgetExceeded>

Source

pub fn check_box_depth(&self, depth: u32) -> Result<(), BudgetExceeded>

Source

pub fn check_workspace( &self, channels: u32, he: bool, ps: bool, ) -> Result<usize, BudgetExceeded>

Source

pub fn effective_output_bytes(&self) -> u64

32-bit hosts cannot Vec more than isize::MAX bytes.

Trait Implementations§

Source§

impl Clone for MemoryBudgets

Source§

fn clone(&self) -> Self

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 MemoryBudgets

Source§

impl Debug for MemoryBudgets

Source§

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

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

impl Default for MemoryBudgets

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for MemoryBudgets

Source§

impl PartialEq for MemoryBudgets

Source§

fn eq(&self, other: &Self) -> 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 MemoryBudgets

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.