ferrin-spec 0.2.0

Ferrin provider specification: model traits, prompt and content types, stream parts, shared errors.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Object-safe files service.

use super::BoxFuture;
use super::ServiceRef;
use super::model_ref::ref_conversions;
use crate::error::ProviderError;
use crate::files::DeleteFileResult;
use crate::files::DownloadFileResult;
use crate::files::FileMetadataResult;
use crate::files::FileReferenceOptions;
use crate::files::Files;
use crate::files::UploadFileOptions;
use crate::files::UploadFileResult;
use crate::shared::ProviderId;

/// Object-safe counterpart of [`Files`].
pub trait DynFiles: Send + Sync + 'static {
    /// See [`Files::provider`].
    fn provider(&self) -> &ProviderId;
    /// See [`Files::upload_file`].
    fn upload_file(
        &self,
        options: UploadFileOptions,
    ) -> BoxFuture<'_, Result<UploadFileResult, ProviderError>>;
    /// See [`Files::supports_get_file_metadata`].
    fn supports_get_file_metadata(&self) -> bool;
    /// See [`Files::get_file_metadata`].
    fn get_file_metadata(
        &self,
        options: FileReferenceOptions,
    ) -> BoxFuture<'_, Result<FileMetadataResult, ProviderError>>;
    /// See [`Files::supports_download_file`].
    fn supports_download_file(&self) -> bool;
    /// See [`Files::download_file`].
    fn download_file(
        &self,
        options: FileReferenceOptions,
    ) -> BoxFuture<'_, Result<DownloadFileResult, ProviderError>>;
    /// See [`Files::supports_delete_file`].
    fn supports_delete_file(&self) -> bool;
    /// See [`Files::delete_file`].
    fn delete_file(
        &self,
        options: FileReferenceOptions,
    ) -> BoxFuture<'_, Result<DeleteFileResult, ProviderError>>;
}

impl<T: Files> DynFiles for T {
    fn provider(&self) -> &ProviderId {
        Files::provider(self)
    }

    fn upload_file(
        &self,
        options: UploadFileOptions,
    ) -> BoxFuture<'_, Result<UploadFileResult, ProviderError>> {
        Box::pin(Files::upload_file(self, options))
    }

    fn supports_get_file_metadata(&self) -> bool {
        Files::supports_get_file_metadata(self)
    }

    fn get_file_metadata(
        &self,
        options: FileReferenceOptions,
    ) -> BoxFuture<'_, Result<FileMetadataResult, ProviderError>> {
        Box::pin(Files::get_file_metadata(self, options))
    }

    fn supports_download_file(&self) -> bool {
        Files::supports_download_file(self)
    }

    fn download_file(
        &self,
        options: FileReferenceOptions,
    ) -> BoxFuture<'_, Result<DownloadFileResult, ProviderError>> {
        Box::pin(Files::download_file(self, options))
    }

    fn supports_delete_file(&self) -> bool {
        Files::supports_delete_file(self)
    }

    fn delete_file(
        &self,
        options: FileReferenceOptions,
    ) -> BoxFuture<'_, Result<DeleteFileResult, ProviderError>> {
        Box::pin(Files::delete_file(self, options))
    }
}

/// Shared reference to a files service.
pub type FilesRef = ServiceRef<dyn DynFiles>;

ref_conversions!(FilesRef, Files, DynFiles);