Skip to main content

Group

Struct Group 

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

Group-level inventory entry that applies values to member hosts.

§Fields

Group fields mirror host fields and are merged during resolution. Groups are stored in the Groups collection keyed by name. Use Groups::add_group(name, group) to add a group entry under a name.

  • hostname - Optional hostname or address applied to member hosts.
  • port - Optional connection port applied to member hosts.
  • username - Optional username applied to member hosts.
  • password - Optional password applied to member hosts.
  • platform - Optional platform identifier applied to member hosts.
  • groups - Optional parent group names for group inheritance.
  • data - Optional arbitrary data merged into member hosts.
  • connection_options - Optional per-connection overrides.
  • Defaults are applied globally via Inventory.

§Deserialization

  • Unknown fields are rejected (via #[serde(deny_unknown_fields)]).
  • Connection options accept arbitrary map keys.

§Examples

use genja_core::inventory::{Group, Groups, BaseBuilderHost};

let mut groups = Groups::new();
let core_group = Group::builder()
    .platform("linux")
    .build();

groups.add_group("core", core_group);
assert_eq!(groups.len(), 1);

Implementations§

Source§

impl Group

Source

pub fn builder() -> GroupBuilder

Returns a builder for creating group entries.

Use the builder to set optional fields before calling build().

Source

pub fn to_builder(&self) -> GroupBuilder

Source

pub fn hostname(&self) -> Option<&str>

Source

pub fn port(&self) -> Option<u16>

Source

pub fn username(&self) -> Option<&str>

Source

pub fn password(&self) -> Option<&str>

Source

pub fn platform(&self) -> Option<&str>

Source

pub fn groups(&self) -> Option<&ParentGroups>

Source

pub fn data(&self) -> Option<&Data>

Source

pub fn connection_options(&self) -> Option<&CustomTreeMap<ConnectionOptions>>

Trait Implementations§

Source§

impl Clone for Group

Source§

fn clone(&self) -> Group

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 Debug for Group

Source§

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

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

impl<'de> Deserialize<'de> for Group

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for Group

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for Group

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Group

§

impl RefUnwindSafe for Group

§

impl Send for Group

§

impl Sync for Group

§

impl Unpin for Group

§

impl UnsafeUnpin for Group

§

impl UnwindSafe for Group

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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.