Struct PluginBuilder 

pub struct PluginBuilder { /* private fields */ }

Builder for creating instances of Plugin.

Provides a fluent interface for constructing a Plugin object with optional fields.

Implementations

impl PluginBuilder

pub fn clear_envvars(self) -> Self

Clears the envvars field.

pub fn clear_name(self) -> Self

Clears the name field.

pub fn clear_origin_id(self) -> Self

Clears the origin_id field.

pub fn built_in(self, built_in: bool) -> Self

Alias for setting the origin_id field.

Arguments

• built_in - A boolean indicating whether the Plugin is built-in.

pub fn envvars(self, envvars: &str) -> Self

Sets the envvars field.

Arguments

• envvars - The environment variables for the Plugin.

pub fn origin_id(self, origin_id: u64) -> Self

Sets the origin_id field.

Arguments

• origin_id - The origin ID of the Plugin. Must be 0 (for built-in plugins) or 1 (for user-uploaded plugins).

pub fn user_uploaded(self, user_uploaded: bool) -> Self

Alias for setting the origin_id field.

Arguments

• user_uploaded - A boolean indicating whether the Plugin is user-uploaded.

Trait Implementations

impl Builder for PluginBuilder

fn new() -> Self

Creates a new instance of PluginBuilder with default values.

Initializes a new builder for creating a Plugin object with all fields in their default state.

Returns

A new instance of PluginBuilder.

fn name(self, name: &str) -> Self

Sets the name field.

Arguments

• name - The name of the Plugin.

fn build(self) -> Result<Self::ConfigObject, OpsviewConfigError>

Consumes the builder and returns a Plugin object.

Returns

A Result containing the constructed Plugin object or an error if the object could not be built due to the absence of the required name field or if the origin_id field is set but not 0 or 1.

Errors

Returns an error if the name field is not set. Returns an error if the origin_id field is set but > 1.

type ConfigObject = Plugin

impl Clone for PluginBuilder

fn clone(&self) -> PluginBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginBuilder

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

Formats the value using the given formatter.

impl Default for PluginBuilder

fn default() -> PluginBuilder

Returns the “default value” for a type.