capnp/
text_list.rs

1// Copyright (c) 2013-2015 Sandstorm Development Group, Inc. and contributors
2// Licensed under the MIT License:
3//
4// Permission is hereby granted, free of charge, to any person obtaining a copy
5// of this software and associated documentation files (the "Software"), to deal
6// in the Software without restriction, including without limitation the rights
7// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8// copies of the Software, and to permit persons to whom the Software is
9// furnished to do so, subject to the following conditions:
10//
11// The above copyright notice and this permission notice shall be included in
12// all copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20// THE SOFTWARE.
21
22//! List of strings containing UTF-8 encoded text.
23
24use crate::private::layout::{ListBuilder, ListReader, Pointer, PointerBuilder, PointerReader};
25use crate::traits::{FromPointerBuilder, FromPointerReader, IndexMove, ListIter, SetterInput};
26use crate::Result;
27
28#[derive(Copy, Clone)]
29pub struct Owned;
30
31impl crate::traits::Owned for Owned {
32    type Reader<'a> = Reader<'a>;
33    type Builder<'a> = Builder<'a>;
34}
35
36impl crate::introspect::Introspect for Owned {
37    fn introspect() -> crate::introspect::Type {
38        crate::introspect::Type::list_of(crate::introspect::TypeVariant::Text.into())
39    }
40}
41
42#[derive(Clone, Copy)]
43pub struct Reader<'a> {
44    reader: ListReader<'a>,
45}
46
47impl<'a> Reader<'a> {
48    pub fn new<'b>(reader: ListReader<'b>) -> Reader<'b> {
49        Reader::<'b> { reader }
50    }
51
52    pub fn len(&self) -> u32 {
53        self.reader.len()
54    }
55
56    pub fn is_empty(&self) -> bool {
57        self.len() == 0
58    }
59
60    pub fn iter(self) -> ListIter<Reader<'a>, Result<crate::text::Reader<'a>>> {
61        let l = self.len();
62        ListIter::new(self, l)
63    }
64
65    pub fn reborrow(&self) -> Reader<'_> {
66        Reader {
67            reader: self.reader,
68        }
69    }
70}
71
72impl<'a> FromPointerReader<'a> for Reader<'a> {
73    fn get_from_pointer(
74        reader: &PointerReader<'a>,
75        default: Option<&'a [crate::Word]>,
76    ) -> Result<Reader<'a>> {
77        Ok(Reader {
78            reader: reader.get_list(Pointer, default)?,
79        })
80    }
81}
82
83impl<'a> IndexMove<u32, Result<crate::text::Reader<'a>>> for Reader<'a> {
84    fn index_move(&self, index: u32) -> Result<crate::text::Reader<'a>> {
85        self.get(index)
86    }
87}
88
89impl<'a> Reader<'a> {
90    /// Gets the `text::Reader` at position `index`. Panics if `index` is
91    /// greater than or equal to `len()`.
92    pub fn get(self, index: u32) -> Result<crate::text::Reader<'a>> {
93        assert!(index < self.len());
94        self.reader.get_pointer_element(index).get_text(None)
95    }
96
97    /// Gets the `text::Reader` at position `index`. Returns `None` if `index`
98    /// is greater than or equal to `len()`.
99    pub fn try_get(self, index: u32) -> Option<Result<crate::text::Reader<'a>>> {
100        if index < self.len() {
101            Some(self.reader.get_pointer_element(index).get_text(None))
102        } else {
103            None
104        }
105    }
106}
107
108impl<'a> crate::traits::IntoInternalListReader<'a> for Reader<'a> {
109    fn into_internal_list_reader(self) -> ListReader<'a> {
110        self.reader
111    }
112}
113
114pub struct Builder<'a> {
115    builder: ListBuilder<'a>,
116}
117
118impl<'a> Builder<'a> {
119    pub fn new(builder: ListBuilder<'a>) -> Builder<'a> {
120        Builder { builder }
121    }
122
123    pub fn len(&self) -> u32 {
124        self.builder.len()
125    }
126
127    pub fn is_empty(&self) -> bool {
128        self.len() == 0
129    }
130
131    #[inline]
132    pub fn set(&mut self, index: u32, value: impl SetterInput<crate::text::Owned>) {
133        assert!(index < self.len());
134        SetterInput::set_pointer_builder(
135            self.builder.reborrow().get_pointer_element(index),
136            value,
137            false,
138        )
139        .unwrap()
140        // The text impls of SetterInput never return an error, so
141        // the above unwrap() won't panic.
142    }
143
144    pub fn into_reader(self) -> Reader<'a> {
145        Reader {
146            reader: self.builder.into_reader(),
147        }
148    }
149
150    pub fn reborrow<'b>(&'b mut self) -> Builder<'b> {
151        Builder::<'b> {
152            builder: self.builder.reborrow(),
153        }
154    }
155}
156
157impl<'a> FromPointerBuilder<'a> for Builder<'a> {
158    fn init_pointer(builder: PointerBuilder<'a>, size: u32) -> Builder<'a> {
159        Builder {
160            builder: builder.init_list(Pointer, size),
161        }
162    }
163    fn get_from_pointer(
164        builder: PointerBuilder<'a>,
165        default: Option<&'a [crate::Word]>,
166    ) -> Result<Builder<'a>> {
167        Ok(Builder {
168            builder: builder.get_list(Pointer, default)?,
169        })
170    }
171}
172
173impl<'a> Builder<'a> {
174    /// Gets the `text::Builder` at position `index`. Panics if `index` is
175    /// greater than or equal to `len()`.
176    pub fn get(self, index: u32) -> Result<crate::text::Builder<'a>> {
177        assert!(index < self.len());
178        self.builder.get_pointer_element(index).get_text(None)
179    }
180
181    /// Gets the `text::Builder` at position `index`. Returns `None` if `index`
182    /// is greater than or equal to `len()`.
183    pub fn try_get(self, index: u32) -> Option<Result<crate::text::Builder<'a>>> {
184        if index < self.len() {
185            Some(self.builder.get_pointer_element(index).get_text(None))
186        } else {
187            None
188        }
189    }
190}
191
192impl<'a> crate::traits::SetterInput<Owned> for Reader<'a> {
193    #[inline]
194    fn set_pointer_builder<'b>(
195        mut pointer: crate::private::layout::PointerBuilder<'b>,
196        value: Reader<'a>,
197        canonicalize: bool,
198    ) -> Result<()> {
199        pointer.set_list(&value.reader, canonicalize)
200    }
201}
202
203impl<'a, T: AsRef<str>> crate::traits::SetterInput<Owned> for &'a [T] {
204    #[inline]
205    fn set_pointer_builder<'b>(
206        pointer: PointerBuilder<'b>,
207        value: &'a [T],
208        _canonicalize: bool,
209    ) -> Result<()> {
210        let mut builder = pointer.init_list(
211            crate::private::layout::ElementSize::Pointer,
212            value.len() as u32,
213        );
214        for (idx, v) in value.iter().enumerate() {
215            builder
216                .reborrow()
217                .get_pointer_element(idx as u32)
218                .set_text(v.as_ref().into());
219        }
220        Ok(())
221    }
222}
223
224impl<'a, T: AsRef<str>, const N: usize> crate::traits::SetterInput<Owned> for &'a [T; N] {
225    #[inline]
226    fn set_pointer_builder<'b>(
227        pointer: PointerBuilder<'b>,
228        value: &'a [T; N],
229        canonicalize: bool,
230    ) -> Result<()> {
231        crate::traits::SetterInput::set_pointer_builder(pointer, &value[..], canonicalize)
232    }
233}
234
235impl<'a> ::core::iter::IntoIterator for Reader<'a> {
236    type Item = Result<crate::text::Reader<'a>>;
237    type IntoIter = ListIter<Reader<'a>, Self::Item>;
238
239    fn into_iter(self) -> Self::IntoIter {
240        self.iter()
241    }
242}
243
244impl<'a> From<Reader<'a>> for crate::dynamic_value::Reader<'a> {
245    fn from(t: Reader<'a>) -> crate::dynamic_value::Reader<'a> {
246        crate::dynamic_value::Reader::List(crate::dynamic_list::Reader {
247            reader: t.reader,
248            element_type: crate::introspect::TypeVariant::Text.into(),
249        })
250    }
251}
252
253impl<'a> crate::dynamic_value::DowncastReader<'a> for Reader<'a> {
254    fn downcast_reader(v: crate::dynamic_value::Reader<'a>) -> Self {
255        let dl: crate::dynamic_list::Reader = v.downcast();
256        assert!(dl
257            .element_type()
258            .loose_equals(crate::introspect::TypeVariant::Text.into()));
259        Reader { reader: dl.reader }
260    }
261}
262
263impl<'a> From<Builder<'a>> for crate::dynamic_value::Builder<'a> {
264    fn from(t: Builder<'a>) -> crate::dynamic_value::Builder<'a> {
265        crate::dynamic_value::Builder::List(crate::dynamic_list::Builder {
266            builder: t.builder,
267            element_type: crate::introspect::TypeVariant::Text.into(),
268        })
269    }
270}
271
272impl<'a> crate::dynamic_value::DowncastBuilder<'a> for Builder<'a> {
273    fn downcast_builder(v: crate::dynamic_value::Builder<'a>) -> Self {
274        let dl: crate::dynamic_list::Builder = v.downcast();
275        assert!(dl
276            .element_type()
277            .loose_equals(crate::introspect::TypeVariant::Text.into()));
278        Builder {
279            builder: dl.builder,
280        }
281    }
282}
283
284impl core::fmt::Debug for Reader<'_> {
285    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
286        core::fmt::Debug::fmt(
287            &::core::convert::Into::<crate::dynamic_value::Reader<'_>>::into(*self),
288            f,
289        )
290    }
291}
capnp/text_list.rs

capnp/
text_list.rs
