Struct Icinga2Async 

pub struct Icinga2Async {
    pub url: Url,
    pub username: String,
    /* private fields */
}

the runtime object for an Icinga2 instance (blocking variant)

Fields

url: Url

the base URL for the Icinga API

username: String

username

Implementations

impl Icinga2Async

pub fn from_instance_config(config: &Icinga2Instance) -> Result<Self, Error>

create a new Icinga2 instance from a config that was either manually created or previously loaded via Icinga2Instance::from_config_file

Errors

this fails if the CA certificate file mentioned in the configuration can not be found or parsed

pub fn from_config_file(path: &Path) -> Result<Self, Error>

create a new Icinga2 instance from a TOML config file

Errors

this fails if the configuration file can not be found or parsed or the CA certificate file mentioned in the configuration file can not be found or parsed

pub async fn rest<ApiEndpoint, Res>( &self, api_endpoint: ApiEndpoint, ) -> Result<Res, Error>

where ApiEndpoint: RestApiEndpoint, <ApiEndpoint as RestApiEndpoint>::RequestBody: Clone + Serialize + Debug, Res: DeserializeOwned + Debug + RestApiResponse<ApiEndpoint>,

common code for the REST API calls

Errors

this returns an error if encoding, the actual request, or decoding of the response fail

pub async fn event_stream( &self, types: &[IcingaEventStreamType], queue: &str, filter: Option<IcingaFilter>, ) -> Result<impl Stream<Item = Result<IcingaEvent, Error>>, Error>

Long-polling on an event stream

Errors

this returns an error if encoding or the actual request fail

Trait Implementations

impl Clone for Icinga2Async

fn clone(&self) -> Icinga2Async

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Icinga2Async

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

Formats the value using the given formatter.