Struct NeutralKronOptions 

#[non_exhaustive]
pub struct NeutralKronOptions {
    pub neutral_terminals: BTreeMap<String, String>,
    pub allow_forced_ideal_ground: bool,
}

Options controlling explicit-neutral identification and grounding.

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

neutral_terminals: BTreeMap<String, String>

Per-bus neutral terminal overrides. Bus identity is case insensitive; terminal identity remains case sensitive.

allow_forced_ideal_ground: bool

Permit an identified neutral that is not listed in the bus’s explicit grounded set to be treated as ideal ground. Off by default because this changes the physical network.

Implementations

impl NeutralKronOptions

pub fn with_neutral_terminal( self, bus: impl Into<String>, terminal: impl Into<String>, ) -> NeutralKronOptions

Override the neutral label for one bus.

pub const fn with_forced_ideal_ground(self, allow: bool) -> NeutralKronOptions

Opt into treating an identified floating neutral as ideal ground.

Trait Implementations

impl Clone for NeutralKronOptions

fn clone(&self) -> NeutralKronOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NeutralKronOptions

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

Formats the value using the given formatter.

impl Default for NeutralKronOptions

fn default() -> NeutralKronOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NeutralKronOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<NeutralKronOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for NeutralKronOptions

impl PartialEq for NeutralKronOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NeutralKronOptions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NeutralKronOptions