Struct storyboard_client::Client

pub struct Client { /* fields omitted */ }

A client type to connect to the StoryBoard API

Methods

impl Client

pub fn get_all_projects(&self) -> Result<Vec<Project>, Error>

Retrieves all the projects from the storyboard API.

Example

extern crate storyboard_client;

use storyboard_client::{Client, Error};

fn example() -> Result<(), Error> {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let projects = client.get_all_projects()?;
    assert_ne!(projects.len(), 0);
    Ok(())
}

pub fn search_projects(&self, s: &str) -> Result<Vec<Project>, Error>

Search projects with the given search string

Example

extern crate storyboard_client;

use storyboard_client::{Client, Error};

fn example() -> Result<(), Error> {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let projects = client.search_projects("stx")?;
    assert_ne!(projects.len(), 0);
    Ok(())
}

pub fn get_project_groups(&self) -> Result<Vec<ProjectGroup>, Error>

Get all registered project groups.

pub fn get_project_groups_by_name(     &self,     name: &str ) -> Result<Vec<ProjectGroup>, Error>

Get a project group by it's name.

pub fn get_projects_in_group(     &self,     g: &ProjectGroup ) -> Result<Vec<Project>, Error>

Retrieves all projects in a project group.

Example

extern crate storyboard_client;

use storyboard_client::{Client, Error, ProjectGroup};

fn example() -> Result<(), Error> {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let group = ProjectGroup { id: 86, ..Default::default() };
    let projects = client.get_projects_in_group(&group)?;
    assert_ne!(projects.len(), 0);
    Ok(())
}

impl Client

pub fn search_stories(&self, s: &str) -> Result<Vec<Story>, Error>

Search stories with the given search string

Example

extern crate storyboard_client;

use storyboard_client::{Client, Error};

fn example() -> Result<(), Error> {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let stories = client.search_stories("stx")?;
    assert_ne!(stories.len(), 0);
    Ok(())
}

pub fn get_tasks_in_story(&self, story: &Story) -> Result<Vec<Task>, Error>

Gets all the tasks within a story.

Example

extern crate storyboard_client;


fn example() -> Result<(), Error> {
    let story = Story { id: 19, ..Default::default() };
    let tasks = client.get_tasks_in_story(&story)?;
    assert_ne!(tasks.len(), 0);
    Ok(())
}

impl Client

pub fn search_tasks(&self, s: &str) -> Result<Vec<Task>, Error>

Search tasks with the given search string

Example

extern crate storyboard_client;

use storyboard_client::{Client, Error};

fn example() -> Result<(), Error> {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let tasks = client.search_tasks("stx")?;
    assert_ne!(tasks.len(), 0);
    Ok(())
}

pub fn get_tasks_in_project_group(     &self,     g: &ProjectGroup ) -> Result<Vec<Task>, Error>

Get all tasks with the given ProjectGroup

Example

extern crate storyboard_client;

use storyboard_client::{Client, Error, ProjectGroup};

fn example() -> Result<(), Error> {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let group = ProjectGroup { id: 86, ..Default::default() };
    let tasks = client.get_tasks_in_project_group(&group)?;
    assert_ne!(tasks.len(), 0);
    Ok(())
}

impl Client

pub fn new(url: &str) -> Client

Creates a new client for the StoryBoard API.

Receives the url of the API endpoint to perform the operations.

Example

extern crate storyboard_client;

use storyboard_client::Client;

fn main() {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
}

pub fn fetch_url<T: DeserializeOwned>(&self, url: &str) -> Result<T, Error>

Function that performs the request with the specified url.

impl Client

pub fn search_users(&self, s: &str) -> Result<Vec<User>, Error>

Search users with the given search string

Example

extern crate storyboard_client;

use storyboard_client::{Client, Error};

fn example() -> Result<(), Error> {
    let client = Client::new("https://storyboard.openstack.org/api/v1");
    let users = client.search_users("erich")?;
    assert_ne!(users.len(), 0);
    Ok(())
}

pub fn get_user_by_email(&self, email: &str) -> Result<Vec<User>, Error>

Search users with the given email.