Struct pi_hole_api::PiHoleAPIConfigWithKey

source · [−]

pub struct PiHoleAPIConfigWithKey { /* private fields */ }

Expand description

Pi Hole API Struct

Implementations

source

impl PiHoleAPIConfigWithKey

source

pub fn new(host: String, api_key: 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 PiHoleAPIConfigWithKey

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for PiHoleAPIConfigWithKey

impl Send for PiHoleAPIConfigWithKey

impl Sync for PiHoleAPIConfigWithKey

impl Unpin for PiHoleAPIConfigWithKey

impl UnwindSafe for PiHoleAPIConfigWithKey

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> AuthenticatedPiHoleAPI for T where
T: PiHoleAPIHost + PiHoleAPIKey,

source

fn get_top_items(&self, count: &Option<u32>) -> Result<TopItems, APIError>

Get the top domains and ads and the number of queries for each. Limit the number of items with count.

source

fn get_top_clients(&self, count: &Option<u32>) -> Result<TopClients, APIError>

Get the top clients and the number of queries for each. Limit the number of items with count.

source

fn get_top_clients_blocked(
&self,
count: Option<u32>
) -> Result<TopClientsBlocked, APIError>

Get the top clients blocked and the number of queries for each. Limit the number of items with count.

source

fn get_forward_destinations(
&self,
unsorted: bool
) -> Result<ForwardDestinations, APIError>

Get the percentage of queries forwarded to each target.

source

fn get_query_types(&self) -> Result<QueryTypes, APIError>

Get the number of queries per type.

source

fn get_all_queries(&self, count: u32) -> Result<Vec<Query, Global>, APIError>

Get all DNS query data. Limit the number of items with count.

source

fn enable(&self) -> Result<Status, APIError>

Enable the Pi-Hole.

source

fn disable(&self, seconds: u64) -> Result<Status, APIError>

Disable the Pi-Hole for seconds seconds.

source

fn get_cache_info(&self) -> Result<CacheInfo, APIError>

Get statistics about the DNS cache.

source

fn get_client_names(&self) -> Result<Vec<ClientName, Global>, APIError>

Get hostname and IP for hosts

source

fn get_over_time_data_clients(
&self
) -> Result<HashMap<String, Vec<u64, Global>, RandomState>, APIError>

Get queries by client over time. Maps timestamp to the number of queries by clients. Order of clients in the Vector is the same as for get_client_names Read more

source

fn get_network(&self) -> Result<Network, APIError>

Get information about network clients.

source

fn get_queries_count(&self) -> Result<u64, APIError>

Get the total number of queries received.

source

fn list_add(
 &self,
 domain: &str,
 list: &str
) -> Result<ListModificationResponse, APIError>

Add domains to a custom white/blacklist. Acceptable lists are: white, black, white_regex, black_regex, white_wild, black_wild, audit. Read more

source

fn list_remove(
 &self,
 domain: &str,
 list: &str
) -> Result<ListModificationResponse, APIError>

Remove domain to a custom white/blacklist. Acceptable lists are: white, black, white_regex, black_regex, white_wild, black_wild, audit. Read more

source

fn list_get_domains(
&self,
list: &str
) -> Result<Vec<CustomListDomainDetails, Global>, APIError>

Get a list of domains on a particular custom white/blacklist Acceptable lists are: white, black, white_regex, black_regex, white_wild, black_wild, audit. Read more

source

fn get_custom_dns_records(
&self
) -> Result<Vec<CustomDNSRecord, Global>, APIError>

Get a list of custom DNS records

source

fn add_custom_dns_record(
 &self,
 ip: &IpAddr,
 domain: &str
) -> Result<ListModificationResponse, APIError>

Add a custom DNS record

source

fn delete_custom_dns_record(
 &self,
 ip: &IpAddr,
 domain: &str
) -> Result<ListModificationResponse, APIError>

Delete a custom DNS record

source

fn get_custom_cname_records(
&self
) -> Result<Vec<CustomCNAMERecord, Global>, APIError>

Get a list of custom CNAME records

source

fn add_custom_cname_record(
 &self,
 domain: &str,
 target_domain: &str
) -> Result<ListModificationResponse, APIError>

Add a custom CNAME record

source

fn delete_custom_cname_record(
 &self,
 domain: &str,
 target_domain: &str
) -> Result<ListModificationResponse, APIError>

Delete a custom CNAME record

source

fn get_max_logage(&self) -> Result<f32, APIError>

Get max logage

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::PiHoleAPIConfigWithKey

Implementations

impl PiHoleAPIConfigWithKey

pub fn new(host: String, api_key: String) -> Self

Trait Implementations

impl Debug for PiHoleAPIConfigWithKey

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

Auto Trait Implementations

impl RefUnwindSafe for PiHoleAPIConfigWithKey

impl Send for PiHoleAPIConfigWithKey

impl Sync for PiHoleAPIConfigWithKey

impl Unpin for PiHoleAPIConfigWithKey

impl UnwindSafe for PiHoleAPIConfigWithKey

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> AuthenticatedPiHoleAPI for T where T: PiHoleAPIHost + PiHoleAPIKey,

fn get_top_items(&self, count: &Option<u32>) -> Result<TopItems, APIError>

fn get_top_clients(&self, count: &Option<u32>) -> Result<TopClients, APIError>

fn get_top_clients_blocked( &self, count: Option<u32>) -> Result<TopClientsBlocked, APIError>

fn get_forward_destinations( &self, unsorted: bool) -> Result<ForwardDestinations, APIError>

fn get_query_types(&self) -> Result<QueryTypes, APIError>

fn get_all_queries(&self, count: u32) -> Result<Vec<Query, Global>, APIError>

fn enable(&self) -> Result<Status, APIError>

fn disable(&self, seconds: u64) -> Result<Status, APIError>

fn get_cache_info(&self) -> Result<CacheInfo, APIError>

fn get_client_names(&self) -> Result<Vec<ClientName, Global>, APIError>

fn get_over_time_data_clients( &self) -> Result<HashMap<String, Vec<u64, Global>, RandomState>, APIError>

fn get_network(&self) -> Result<Network, APIError>

fn get_queries_count(&self) -> Result<u64, APIError>

fn list_add( &self, domain: &str, list: &str) -> Result<ListModificationResponse, APIError>

fn list_remove( &self, domain: &str, list: &str) -> Result<ListModificationResponse, APIError>

fn list_get_domains( &self, list: &str) -> Result<Vec<CustomListDomainDetails, Global>, APIError>

fn get_custom_dns_records( &self) -> Result<Vec<CustomDNSRecord, Global>, APIError>

fn add_custom_dns_record( &self, ip: &IpAddr, domain: &str) -> Result<ListModificationResponse, APIError>

fn delete_custom_dns_record( &self, ip: &IpAddr, domain: &str) -> Result<ListModificationResponse, APIError>

fn get_custom_cname_records( &self) -> Result<Vec<CustomCNAMERecord, Global>, APIError>

fn add_custom_cname_record( &self, domain: &str, target_domain: &str) -> Result<ListModificationResponse, APIError>

fn delete_custom_cname_record( &self, domain: &str, target_domain: &str) -> Result<ListModificationResponse, APIError>

fn get_max_logage(&self) -> Result<f32, APIError>

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> AuthenticatedPiHoleAPI for T where
T: PiHoleAPIHost + PiHoleAPIKey,

fn get_top_clients_blocked(
&self,
count: Option<u32>
) -> Result<TopClientsBlocked, APIError>

fn get_forward_destinations(
&self,
unsorted: bool
) -> Result<ForwardDestinations, APIError>

fn get_over_time_data_clients(
&self
) -> Result<HashMap<String, Vec<u64, Global>, RandomState>, APIError>

fn list_add(
&self,
domain: &str,
list: &str
) -> Result<ListModificationResponse, APIError>

fn list_remove(
&self,
domain: &str,
list: &str
) -> Result<ListModificationResponse, APIError>

fn list_get_domains(
&self,
list: &str
) -> Result<Vec<CustomListDomainDetails, Global>, APIError>

fn get_custom_dns_records(
&self
) -> Result<Vec<CustomDNSRecord, Global>, APIError>

fn add_custom_dns_record(
&self,
ip: &IpAddr,
domain: &str
) -> Result<ListModificationResponse, APIError>

fn delete_custom_dns_record(
&self,
ip: &IpAddr,
domain: &str
) -> Result<ListModificationResponse, APIError>

fn get_custom_cname_records(
&self
) -> Result<Vec<CustomCNAMERecord, Global>, APIError>

fn add_custom_cname_record(
&self,
domain: &str,
target_domain: &str
) -> Result<ListModificationResponse, APIError>

fn delete_custom_cname_record(
&self,
domain: &str,
target_domain: &str
) -> Result<ListModificationResponse, APIError>

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,