gix_object/tag/
write.rs

1use std::io;
2
3use bstr::BStr;
4
5use crate::{encode, encode::NL, Kind, Tag, TagRef};
6
7/// An Error used in [`Tag::write_to()`][crate::WriteTo::write_to()].
8#[derive(Debug, thiserror::Error)]
9#[allow(missing_docs)]
10pub enum Error {
11    #[error("Tags must not start with a dash: '-'")]
12    StartsWithDash,
13    #[error("The tag name was no valid reference name")]
14    InvalidRefName(#[from] gix_validate::tag::name::Error),
15}
16
17impl From<Error> for io::Error {
18    fn from(err: Error) -> Self {
19        io::Error::new(io::ErrorKind::Other, err)
20    }
21}
22
23impl crate::WriteTo for Tag {
24    fn write_to(&self, out: &mut dyn io::Write) -> io::Result<()> {
25        encode::trusted_header_id(b"object", &self.target, out)?;
26        encode::trusted_header_field(b"type", self.target_kind.as_bytes(), out)?;
27        encode::header_field(b"tag", validated_name(self.name.as_ref())?, out)?;
28        if let Some(tagger) = &self.tagger {
29            encode::trusted_header_signature(b"tagger", &tagger.to_ref(), out)?;
30        }
31
32        if !self.message.iter().all(|b| *b == b'\n') {
33            out.write_all(NL)?;
34        }
35        out.write_all(self.message.as_ref())?;
36        if let Some(message) = &self.pgp_signature {
37            out.write_all(NL)?;
38            out.write_all(message.as_ref())?;
39        }
40        Ok(())
41    }
42
43    fn kind(&self) -> Kind {
44        Kind::Tag
45    }
46
47    fn size(&self) -> u64 {
48        (b"object".len() + 1 /* space */ + self.target.kind().len_in_hex() + 1 /* nl */
49            + b"type".len() + 1 /* space */ + self.target_kind.as_bytes().len() + 1 /* nl */
50            + b"tag".len() + 1 /* space */ + self.name.len() + 1 /* nl */
51            + self
52            .tagger
53            .as_ref()
54            .map_or(0, |t| b"tagger".len() + 1 /* space */ + t.size() + 1 /* nl */)
55            + if self.message.iter().all(|b| *b == b'\n') { 0 } else { 1 /* nl */ } + self.message.len()
56            + self.pgp_signature.as_ref().map_or(0, |m| 1 /* nl */ + m.len())) as u64
57    }
58}
59
60impl crate::WriteTo for TagRef<'_> {
61    fn write_to(&self, mut out: &mut dyn io::Write) -> io::Result<()> {
62        encode::trusted_header_field(b"object", self.target, &mut out)?;
63        encode::trusted_header_field(b"type", self.target_kind.as_bytes(), &mut out)?;
64        encode::header_field(b"tag", validated_name(self.name)?, &mut out)?;
65        if let Some(tagger) = &self.tagger {
66            encode::trusted_header_signature(b"tagger", tagger, &mut out)?;
67        }
68
69        if !self.message.iter().all(|b| *b == b'\n') {
70            out.write_all(NL)?;
71        }
72        out.write_all(self.message)?;
73        if let Some(message) = self.pgp_signature {
74            out.write_all(NL)?;
75            out.write_all(message)?;
76        }
77        Ok(())
78    }
79
80    fn kind(&self) -> Kind {
81        Kind::Tag
82    }
83
84    fn size(&self) -> u64 {
85        (b"object".len() + 1 /* space */ + self.target().kind().len_in_hex() + 1 /* nl */
86            + b"type".len() + 1 /* space */ + self.target_kind.as_bytes().len() + 1 /* nl */
87            + b"tag".len() + 1 /* space */ + self.name.len() + 1 /* nl */
88            + self
89                .tagger
90                .as_ref()
91                .map_or(0, |t| b"tagger".len() + 1 /* space */ + t.size() + 1 /* nl */)
92            + if self.message.iter().all(|b| *b == b'\n') { 0 } else { 1 /* nl */ } + self.message.len()
93            + self.pgp_signature.as_ref().map_or(0, |m| 1 /* nl */ + m.len())) as u64
94    }
95}
96
97fn validated_name(name: &BStr) -> Result<&BStr, Error> {
98    gix_validate::tag::name(name)?;
99    if name[0] == b'-' {
100        return Err(Error::StartsWithDash);
101    }
102    Ok(name)
103}
104
105#[cfg(test)]
106mod tests;
gix_object/tag/write.rs

gix_object/tag/
write.rs
