Struct jellyfin_sdk_rust::JellyfinSDK[−][src]

pub struct JellyfinSDK { /* fields omitted */ }

Expand description

Main structure representing the Jellyfin instance.

Must be used to interact with Jellyfin server across different ways:

API calls
Servers discovery
WebSockets calls

Implementations

[src]

impl JellyfinSDK

[src]

pub fn new() -> Self

Instantiates a new JellyfinSDK instance.

[src]

pub fn create_api<S: Into<String>>(&mut self, base_addr: S, token: Option<&str>)

Creates a new JellyfinAPI instance.

[src]

pub fn get_api(&self) -> JellyfinSDKResult<&JellyfinAPI>

Tries getting the JellyfinAPI instance.

Returns an JellyfinSDKError if no JellyfinAPI has been initialized before calling this method.

[src]

pub fn get_api_unchecked(&self) -> &JellyfinAPI

Force getting the JellyfinAPI instance.

Must be used carefully. Panics if no instance has been initialized before calling this method.

Trait Implementations

[src]

impl Default for JellyfinSDK

[src]

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl !RefUnwindSafe for JellyfinSDK

impl Send for JellyfinSDK

impl Sync for JellyfinSDK

impl Unpin for JellyfinSDK

impl !UnwindSafe for JellyfinSDK

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

impl<T> WithSubscriber for T

[src]

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

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct jellyfin_sdk_rust::JellyfinSDK[−][src]

Implementations

impl JellyfinSDK

pub fn new() -> Self

pub fn create_api<S: Into<String>>(&mut self, base_addr: S, token: Option<&str>)

pub fn get_api(&self) -> JellyfinSDKResult<&JellyfinAPI>

pub fn get_api_unchecked(&self) -> &JellyfinAPI

Trait Implementations

impl Default for JellyfinSDK

fn default() -> Self

Auto Trait Implementations

impl !RefUnwindSafe for JellyfinSDK

impl Send for JellyfinSDK

impl Sync for JellyfinSDK

impl Unpin for JellyfinSDK

impl !UnwindSafe for JellyfinSDK

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Error = Infallible

pub 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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct jellyfin_sdk_rust::JellyfinSDK[−][src]

Implementations

impl JellyfinSDK

pub fn new() -> Self

pub fn create_api<S: Into<String>>(&mut self, base_addr: S, token: Option<&str>)

pub fn get_api(&self) -> JellyfinSDKResult<&JellyfinAPI>

pub fn get_api_unchecked(&self) -> &JellyfinAPI

Trait Implementations

impl Default for JellyfinSDK

fn default() -> Self

Auto Trait Implementations

impl !RefUnwindSafe for JellyfinSDK

impl Send for JellyfinSDK

impl Sync for JellyfinSDK

impl Unpin for JellyfinSDK

impl !UnwindSafe for JellyfinSDK

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Error = Infallible

pub 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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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>,

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