Struct redmine_api::api::Redmine

pub struct Redmine { /* private fields */ }

main API client object

Implementations

impl Redmine

pub fn new(redmine_url: Url, api_key: &str) -> Result<Self, Error>

create a Redmine object

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

create a Redmine object from the environment variables

REDMINE_API_KEY REDMINE_URL

pub fn impersonate_user(&mut self, id: u64)

Sets the user id of a user to impersonate in all future API calls

this requires Redmine admin privileges

pub fn issue_url(&self, issue_id: u64) -> Url

returns the issue URL for a given issue id

this is mostly for convenience since we are already storing the redmine URL and it works entirely on the client

pub fn ignore_response_body<E>(&self, endpoint: &E) -> Result<(), Error> where
    E: Endpoint, 

use this with endpoints that have no response body, e.g. those just deleting a Redmine object

pub fn json_response_body<E, R>(&self, endpoint: &E) -> Result<R, Error> where
    E: Endpoint + ReturnsJsonResponse,
    R: DeserializeOwned + Debug, 

use this with endpoints which return a JSON response but do not support pagination

you can use it with those that support pagination but they will only return the first page

pub fn json_response_body_page<E, R>(
    &self,
    endpoint: &E,
    offset: u64,
    limit: u64
) -> Result<ResponsePage<R>, Error> where
    E: Endpoint + ReturnsJsonResponse + Pageable,
    R: DeserializeOwned + Debug, 

use this to get a single page of a paginated JSON response

pub fn json_response_body_all_pages<E, R>(
    &self,
    endpoint: &E
) -> Result<Vec<R>, Error> where
    E: Endpoint + ReturnsJsonResponse + Pageable,
    R: DeserializeOwned + Debug, 

use this to get the results for all pages of a paginated JSON response

Trait Implementations

impl Debug for Redmine

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

Formats the value using the given formatter.