Skip to main content

DssReadLimits

Struct DssReadLimits 

Source
#[non_exhaustive]
pub struct DssReadLimits { pub max_include_bytes: usize, pub max_properties: usize, }
Expand description

The two limits on one OpenDSS read that a large case can reach and a caller may raise.

Both bound the work and memory a script can demand, whatever its size on disk: an include that redirects to itself is executed again on every load, and one like= copies a whole property list. The defaults suit input the caller does not trust. A case with several hundred thousand lines and loads, such as a SMART-DS region, needs more than the defaults allow; a caller that trusts the case and has the memory for it raises them:

use powerio_dist::dss::DssReadLimits;

let limits = DssReadLimits::default()
    .max_include_bytes(1 << 30)
    .max_properties(1 << 26);
assert!(limits.max_include_bytes > DssReadLimits::default().max_include_bytes);

The other limits are fixed: 4,096 included files, 64 levels of include nesting, and 65,536 retained records on any one object. A file source also keeps its own limit on the bytes it acquires ([powerio_core::Source::acquisition_byte_limit]).

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_include_bytes: usize

Bytes the read may pull in through Redirect, Compile, Buscoords and loadshape files together. A file executed twice is charged twice. The root file is not charged. Once the total reaches the limit the include that crossed it completes and every later one is refused with READ.DSS.INCLUDE_BUDGET. Default: 64 MiB.

§max_properties: usize

Property assignments and edit records retained across every object, together with the per-object work of commands that visit many objects (BatchEdit, a Solve or CalcVoltageBases recorded against each line). At the limit the read drops further assignments with READ.DSS.VALUE_CLAMPED or stops with READ.DSS.INCLUDE_BUDGET. Memory grows with the count: a region that retained 4.5 million read with a peak of about 2.3 GB. Default: 4,194,304.

Implementations§

Source§

impl DssReadLimits

Source

pub fn max_include_bytes(self, bytes: usize) -> Self

Set the bytes the read may pull in through includes.

Source

pub fn max_properties(self, count: usize) -> Self

Set the property assignments and edit records the read may retain.

Trait Implementations§

Source§

impl Clone for DssReadLimits

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 DssReadLimits

Source§

impl Debug for DssReadLimits

Source§

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

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

impl Default for DssReadLimits

Source§

fn default() -> Self

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

impl Eq for DssReadLimits

Source§

impl PartialEq for DssReadLimits

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 DssReadLimits

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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.