Struct jira_query::JiraInstance

pub struct JiraInstance {
    pub host: String,
    pub auth: Auth,
    pub pagination: Pagination,
    /* private fields */
}

Configuration and credentials to access a Jira instance.

Fields

host: String

auth: Auth

pagination: Pagination

Implementations

impl JiraInstance

pub fn at(host: String) -> Result<Self, JiraQueryError>

Create a new BzInstance struct using a host URL, with default values for all options.

pub fn authenticate(self, auth: Auth) -> Self

Set the authentication method of this JiraInstance.

pub const fn paginate(self, pagination: Pagination) -> Self

Set the pagination method of this JiraInstance.

pub async fn issue(&self, key: &str) -> Result<Issue, JiraQueryError>

Access a single issue by its key.

pub async fn issues(&self, keys: &[&str]) -> Result<Vec<Issue>, JiraQueryError>

Access several issues by their keys.

If the list of keys is empty, returns an empty list back with no errors.

pub async fn search(&self, query: &str) -> Result<Vec<Issue>, JiraQueryError>

Access issues using a free-form JQL search.

An example of a query: project="CentOS Stream" AND priority = High.