box-open-sdk 0.4.1

Box API client for Rust (open source, community, punk rock) — typed models, async managers, and a reqwest runtime with retry, backoff, and token refresh.
Documentation
// Code generated by box-gantry. DO NOT EDIT.

use crate::internal::path_escape;
use crate::runtime::{self, Error};

/// Optional parameters for [`CollectionsManager::list`].
#[derive(Clone, Debug, Default)]
pub struct CollectionsListOptions {
    pub fields: Option<Vec<String>>,
    pub offset: Option<i64>,
    pub limit: Option<i64>,
}

/// Optional parameters for [`CollectionsManager::list_items`].
#[derive(Clone, Debug, Default)]
pub struct CollectionsListItemsOptions {
    pub fields: Option<Vec<String>>,
    pub offset: Option<i64>,
    pub limit: Option<i64>,
}

/// Async paginator over [`CollectionsManager::list`], yielding one `crate::models::schemas::Collection`
/// per item across pages (FR-7.3).
pub struct CollectionsListPaginator {
    manager: CollectionsManager,
    options: CollectionsListOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::Collection>,
    done: bool,
}

impl CollectionsListPaginator {
    /// The next item, advancing pages as needed; `None` at the end.
    /// An error is yielded once, then iteration stops.
    pub async fn next(&mut self) -> Option<Result<crate::models::schemas::Collection, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self.manager.list_page(Some(self.options.clone())).await {
                Ok(page) => page,
                Err(err) => {
                    self.done = true;
                    return Some(Err(err));
                }
            };
            let items = page.entries.unwrap_or_default();
            if items.is_empty() {
                self.done = true;
            } else {
                let next = self.options.offset.unwrap_or(0) + items.len() as i64;
                self.options.offset = Some(next);
            }
            self.buffer = items.into_iter();
        }
    }
}

/// Async paginator over [`CollectionsManager::list_items`], yielding one `crate::models::schemas::Item`
/// per item across pages (FR-7.3).
pub struct CollectionsListItemsPaginator {
    manager: CollectionsManager,
    collection_id: String,
    options: CollectionsListItemsOptions,
    buffer: std::vec::IntoIter<crate::models::schemas::Item>,
    done: bool,
}

impl CollectionsListItemsPaginator {
    /// The next item, advancing pages as needed; `None` at the end.
    /// An error is yielded once, then iteration stops.
    pub async fn next(&mut self) -> Option<Result<crate::models::schemas::Item, Error>> {
        loop {
            if let Some(item) = self.buffer.next() {
                return Some(Ok(item));
            }
            if self.done {
                return None;
            }
            let page = match self
                .manager
                .list_items_page(self.collection_id.clone(), Some(self.options.clone()))
                .await
            {
                Ok(page) => page,
                Err(err) => {
                    self.done = true;
                    return Some(Err(err));
                }
            };
            let items = page.entries.unwrap_or_default();
            if items.is_empty() {
                self.done = true;
            } else {
                let next = self.options.offset.unwrap_or(0) + items.len() as i64;
                self.options.offset = Some(next);
            }
            self.buffer = items.into_iter();
        }
    }
}

/// Operations for the "collections" API area.
pub struct CollectionsManager {
    session: std::sync::Arc<runtime::Client>,
}

impl CollectionsManager {
    pub(crate) fn new(session: std::sync::Arc<runtime::Client>) -> Self {
        Self { session }
    }

    async fn list_page(
        &self,
        opts: Option<CollectionsListOptions>,
    ) -> Result<crate::models::schemas::Collections, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/collections");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.fields {
            req = runtime::with_query(req, "fields", &value.join(","));
        }
        if let Some(value) = opts.offset {
            req = runtime::with_query(req, "offset", &value.to_string());
        }
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::Collection` across pages, threading the cursor.
    pub fn list(&self, opts: Option<CollectionsListOptions>) -> CollectionsListPaginator {
        CollectionsListPaginator {
            manager: CollectionsManager::new(self.session.clone()),
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    async fn list_items_page(
        &self,
        collection_id: String,
        opts: Option<CollectionsListItemsOptions>,
    ) -> Result<crate::models::schemas::ItemsOffsetPaginated, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/collections");
        url.push('/');
        let seg = path_escape(&collection_id);
        url.push_str(&seg);
        url.push_str("/items");
        let mut req = self.session.new_request("GET", &url);
        let opts = opts.unwrap_or_default();
        if let Some(value) = opts.fields {
            req = runtime::with_query(req, "fields", &value.join(","));
        }
        if let Some(value) = opts.offset {
            req = runtime::with_query(req, "offset", &value.to_string());
        }
        if let Some(value) = opts.limit {
            req = runtime::with_query(req, "limit", &value.to_string());
        }
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }

    /// Iterate every `crate::models::schemas::Item` across pages, threading the cursor.
    pub fn list_items(
        &self,
        collection_id: String,
        opts: Option<CollectionsListItemsOptions>,
    ) -> CollectionsListItemsPaginator {
        CollectionsListItemsPaginator {
            manager: CollectionsManager::new(self.session.clone()),
            collection_id,
            options: opts.unwrap_or_default(),
            buffer: Vec::new().into_iter(),
            done: false,
        }
    }

    pub async fn get(
        &self,
        collection_id: String,
    ) -> Result<crate::models::schemas::Collection, Error> {
        let mut url = self.session.base_url("api");
        url.push_str("/collections");
        url.push('/');
        let seg = path_escape(&collection_id);
        url.push_str(&seg);
        let req = self.session.new_request("GET", &url);
        let resp = self.session.fetch(req).await?;
        let data = runtime::response_bytes(&resp)?;
        Ok(serde_json::from_slice(&data)?)
    }
}