Struct pi_hole_api::PiHoleAPIConfig

source · [−]

pub struct PiHoleAPIConfig { /* private fields */ }

Expand description

Pi Hole API Struct

Implementations

source

impl PiHoleAPIConfig

source

pub fn new(host: String) -> Self

Creates a new Pi Hole API instance. host must begin with the protocol e.g. http:// or https://

Trait Implementations

source

impl Debug for PiHoleAPIConfig

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for PiHoleAPIConfig

impl Send for PiHoleAPIConfig

impl Sync for PiHoleAPIConfig

impl Unpin for PiHoleAPIConfig

impl UnwindSafe for PiHoleAPIConfig

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> UnauthenticatedPiHoleAPI for T where
T: PiHoleAPIHost,

source

fn get_version(&self) -> Result<u32, APIError>

Get simple PiHole version

source

fn get_versions(&self) -> Result<Versions, APIError>

Get versions of core, FTL and web and if updates are available

source

fn get_summary_raw(&self) -> Result<SummaryRaw, APIError>

Get statistics in a raw format (no number format)

source

fn get_summary(&self) -> Result<Summary, APIError>

Get statistics in a formatted style

source

fn get_over_time_data_10_mins(&self) -> Result<OverTimeData, APIError>

Get statistics on the number of domains and ads for each 10 minute period

Struct pi_hole_api::PiHoleAPIConfig

Implementations

impl PiHoleAPIConfig

pub fn new(host: String) -> Self

Trait Implementations

impl Debug for PiHoleAPIConfig

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

Auto Trait Implementations

impl RefUnwindSafe for PiHoleAPIConfig

impl Send for PiHoleAPIConfig

impl Sync for PiHoleAPIConfig

impl Unpin for PiHoleAPIConfig

impl UnwindSafe for PiHoleAPIConfig

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> UnauthenticatedPiHoleAPI for T where
T: PiHoleAPIHost,

fn get_version(&self) -> Result<u32, APIError>

fn get_versions(&self) -> Result<Versions, APIError>

fn get_summary_raw(&self) -> Result<SummaryRaw, APIError>

fn get_summary(&self) -> Result<Summary, APIError>

fn get_over_time_data_10_mins(&self) -> Result<OverTimeData, APIError>

Struct pi_hole_api::PiHoleAPIConfig

Implementations

impl PiHoleAPIConfig

pub fn new(host: String) -> Self

Trait Implementations

impl Debug for PiHoleAPIConfig

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

Auto Trait Implementations

impl RefUnwindSafe for PiHoleAPIConfig

impl Send for PiHoleAPIConfig

impl Sync for PiHoleAPIConfig

impl Unpin for PiHoleAPIConfig

impl UnwindSafe for PiHoleAPIConfig

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> UnauthenticatedPiHoleAPI for T where T: PiHoleAPIHost,

fn get_version(&self) -> Result<u32, APIError>

fn get_versions(&self) -> Result<Versions, APIError>

fn get_summary_raw(&self) -> Result<SummaryRaw, APIError>

fn get_summary(&self) -> Result<Summary, APIError>

fn get_over_time_data_10_mins(&self) -> Result<OverTimeData, APIError>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> UnauthenticatedPiHoleAPI for T where
T: PiHoleAPIHost,