objectiveai-sdk 2.0.6

ObjectiveAI SDK, definitions, and utilities
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
98
99
100
101
102
103
104
105
106
107
108

use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[schemars(rename = "filesystem.config.Favorite")]
pub struct Favorite {
    name: String,
    #[serde(flatten)]
    #[schemars(schema_with = "crate::flatten_schema::<crate::RemotePathCommitOptional>")]
    pub path: crate::RemotePathCommitOptional,
    note: String,
}

impl Favorite {
    pub fn new(
        name: String,
        path: crate::RemotePathCommitOptional,
        note: String,
    ) -> Result<Self, super::super::Error> {
        validate_favorite_name(&name)?;
        validate_favorite_note(&note)?;
        Ok(Self { name, path, note })
    }

    pub fn get_name(&self) -> &str {
        &self.name
    }

    pub fn set_name(&mut self, name: String) -> Result<(), super::super::Error> {
        validate_favorite_name(&name)?;
        self.name = name;
        Ok(())
    }

    pub fn get_note(&self) -> &str {
        &self.note
    }

    pub fn set_note(&mut self, note: String) -> Result<(), super::super::Error> {
        validate_favorite_note(&note)?;
        self.note = note;
        Ok(())
    }

    pub fn path(&self) -> &crate::RemotePathCommitOptional {
        &self.path
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[schemars(rename = "filesystem.config.PairFavorite")]
pub struct PairFavorite {
    name: String,
    pub function: crate::RemotePathCommitOptional,
    pub profile: crate::RemotePathCommitOptional,
    note: String,
}

impl PairFavorite {
    pub fn new(
        name: String,
        function: crate::RemotePathCommitOptional,
        profile: crate::RemotePathCommitOptional,
        note: String,
    ) -> Result<Self, super::super::Error> {
        validate_favorite_name(&name)?;
        validate_favorite_note(&note)?;
        Ok(Self { name, function, profile, note })
    }

    pub fn get_name(&self) -> &str {
        &self.name
    }

    pub fn set_name(&mut self, name: String) -> Result<(), super::super::Error> {
        validate_favorite_name(&name)?;
        self.name = name;
        Ok(())
    }

    pub fn get_note(&self) -> &str {
        &self.note
    }

    pub fn set_note(&mut self, note: String) -> Result<(), super::super::Error> {
        validate_favorite_note(&note)?;
        self.note = note;
        Ok(())
    }
}

/// Validates a favorite name: alphanumeric and dashes only, max 64 characters.
pub fn validate_favorite_name(name: &str) -> Result<(), super::super::Error> {
    if name.is_empty() || name.len() > 64 {
        return Err(super::super::Error::InvalidFavoriteName(name.to_string()));
    }
    if !name.chars().all(|c| c.is_ascii_alphanumeric() || c == '-') {
        return Err(super::super::Error::InvalidFavoriteName(name.to_string()));
    }
    Ok(())
}

/// Validates a favorite note: max 512 characters.
pub fn validate_favorite_note(note: &str) -> Result<(), super::super::Error> {
    if note.len() > 512 {
        return Err(super::super::Error::InvalidFavoriteNote(note.to_string()));
    }
    Ok(())
}