Struct hop::Hop

pub struct Hop {
    pub users: Users,
    pub projects: Projects,
    pub registry: Registry,
    pub channels: Channels,
    pub ignite: Ignite,
    pub webhooks: Webhooks,
}

Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK.

Examples

use hop::Hop;

let hop = Hop::new();

Fields

users: Users

projects: Projects

registry: Registry

channels: Channels

ignite: Ignite

webhooks: Webhooks

Implementations

impl Hop

pub fn new() -> Result<Self, Error>

Creates a new Hop instance with default options. This will use the default Hop API URL and will not use a token. If you need to use a token or a custom API URL, use new_with_options instead.

Examples

use hop::Hop;

let hop = Hop::new()?;

Errors

This method will return an error if:

• If a TLS backend cannot be initialized (via reqwest)

pub fn new_with_options(options: HopOptions) -> Result<Self, Error>

Creates a new Hop instance with the provided options.

Examples

use hop::Hop;

let hop = Hop::new_with_options(HopOptions {
    token: Some("my-token".to_owned()),
    api_url: Some("http://localhost:8080/v1".to_owned()),
})?;

Errors

This method will return an error if:

• If a TLS backend cannot be initialized (via reqwest)
• If the provided

Trait Implementations

impl Clone for Hop

fn clone(&self) -> Hop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hop

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

Formats the value using the given formatter.