Skip to main content

NotificationApi

Struct NotificationApi 

Source
pub struct NotificationApi<'a> { /* private fields */ }
Expand description

Main interface for TorBox general operations

Provides methods for all general API calls including:

  • Up status
  • Changelogs in both RSS and JSON
  • Test files

Implementations§

Source§

impl<'a> NotificationApi<'a>

Source

pub fn new(client: &'a TorboxClient) -> NotificationApi<'a>

Source

pub async fn get_rss_feed(&self) -> Result<String, ApiError>

Source

pub async fn get_feed( &self, ) -> Result<ApiResponse<Vec<NotificationFeed>>, ApiError>

Source

pub async fn clear(&self, id: u64) -> Result<ApiResponse<()>, ApiError>

Source

pub async fn clear_all(&self) -> Result<ApiResponse<()>, ApiError>

Source

pub async fn send_test(&self) -> Result<ApiResponse<()>, ApiError>

Trait Implementations§

Source§

impl<'a> NamedType for NotificationApi<'a>

Source§

fn sid() -> SpectaID

Source§

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.
Source§

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.
Source§

impl<'a> Type for NotificationApi<'a>

Source§

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics. Read more
Source§

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.
Source§

impl<'a> Flatten for NotificationApi<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for NotificationApi<'a>

§

impl<'a> !RefUnwindSafe for NotificationApi<'a>

§

impl<'a> Send for NotificationApi<'a>

§

impl<'a> Sync for NotificationApi<'a>

§

impl<'a> Unpin for NotificationApi<'a>

§

impl<'a> UnsafeUnpin for NotificationApi<'a>

§

impl<'a> !UnwindSafe for NotificationApi<'a>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,