Skip to main content

openai_interface/containers/
retrieve.rs

1//! Retrieve a container via `GET /containers/{container_id}`.
2//!
3//! > ![warn] This module is untested!
4//! > If you encounter any issues, please report them on the repository.
5
6use url::Url;
7
8use crate::{
9    containers::Container,
10    errors::OapiError,
11    rest::get::{Get, GetNoStream},
12};
13
14/// Retrieves a container by its ID.
15#[derive(Debug, Clone)]
16pub struct RetrieveContainerRequest<'a> {
17    /// The ID of the container to retrieve, e.g. `cntr_...`.
18    pub container_id: &'a str,
19}
20
21impl Get for RetrieveContainerRequest<'_> {
22    /// Builds the URL for the request.
23    ///
24    /// `base_url` should be like <https://api.openai.com/v1>
25    fn build_url(&self, base_url: &str) -> Result<String, OapiError> {
26        let mut url = Url::parse(base_url.trim_end_matches('/')).map_err(OapiError::UrlError)?;
27        url.path_segments_mut()
28            .map_err(|_| OapiError::UrlCannotBeBase(base_url.to_string()))?
29            .push("containers")
30            .push(self.container_id);
31        Ok(url.to_string())
32    }
33}
34
35impl GetNoStream for RetrieveContainerRequest<'_> {
36    type Response = Container;
37}