Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Variants to be a ShortVec<Variant> #1988

Merged
merged 2 commits into from
Jun 14, 2022
Merged

Change Variants to be a ShortVec<Variant> #1988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ea56aa
Change Variants to be a ShortVec<Variant>
Jun 3, 2022
98e37fa
Remove unused methods and make ShortVec crate-private.
yzhang1994 Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions components/locid/src/helpers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ impl<T> From<Vec<T>> for ShortVec<T> {
}
}

impl<T> Default for ShortVec<T> {
fn default() -> Self {
ShortVec::Empty
}
}

macro_rules! impl_writeable_for_single_subtag {
($type:tt, $sample:literal) => {
impl core::fmt::Display for $type {
Expand Down
76 changes: 6 additions & 70 deletions components/locid/src/subtags/variants.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).

use super::Variant;
use alloc::boxed::Box;
use crate::helpers::ShortVec;

use alloc::vec::Vec;
use core::ops::Deref;
Expand All @@ -29,7 +29,7 @@ use core::ops::Deref;
/// assert_eq!(variants.to_string(), "macos-posix");
/// ```
#[derive(Default, Debug, PartialEq, Eq, Clone, Hash, PartialOrd, Ord)]
pub struct Variants(Option<Box<[Variant]>>);
pub struct Variants(ShortVec<Variant>);

impl Variants {
/// Returns a new empty list of variants. Same as [`default()`](Default::default()), but is `const`.
Expand All @@ -43,7 +43,7 @@ impl Variants {
/// ```
#[inline]
pub const fn new() -> Self {
Self(None)
Self(ShortVec::new())
}

/// Creates a new [`Variants`] set from a [`Vec`].
Expand All @@ -68,67 +68,7 @@ impl Variants {
/// for the caller to use [`binary_search`](slice::binary_search) instead of [`sort`](slice::sort)
/// and [`dedup`](Vec::dedup()).
pub fn from_vec_unchecked(input: Vec<Variant>) -> Self {
if input.is_empty() {
Self(None)
} else {
Self(Some(input.into_boxed_slice()))
}
}

/// Deconstructs the [`Variants`] into raw format to be consumed
/// by [`from_raw_unchecked()`](Variants::from_raw_unchecked()).
///
/// # Examples
///
/// ```
/// use icu::locid::subtags::{Variant, Variants};
///
/// let variant1: Variant = "posix".parse().expect("Parsing failed.");
/// let variant2: Variant = "macos".parse().expect("Parsing failed.");
/// let mut v = vec![variant1, variant2];
/// v.sort();
/// v.dedup();
///
/// let variants = unsafe { Variants::from_vec_unchecked(v) };
///
/// let raw = variants.into_raw();
/// let variants = unsafe { Variants::from_raw_unchecked(raw) };
/// assert_eq!(variants.len(), 2);
/// ```
pub fn into_raw(self) -> Option<Box<[Variant]>> {
self.0
}

/// Constructor which takes a raw value returned by [`into_raw()`](Variants::into_raw()).
///
/// # Examples
///
/// ```
/// use icu::locid::subtags::{Variant, Variants};
///
/// let variant1: Variant = "posix".parse().expect("Parsing failed.");
/// let variant2: Variant = "macos".parse().expect("Parsing failed.");
/// let mut v = vec![variant1, variant2];
/// v.sort();
/// v.dedup();
///
/// let variants = unsafe { Variants::from_vec_unchecked(v) };
///
/// let raw = variants.into_raw();
/// let variants = unsafe { Variants::from_raw_unchecked(raw) };
/// assert_eq!(variants.len(), 2);
/// ```
///
/// Notice: For performance- and memory-constrained environments, it is recommended
/// for the caller to use [`binary_search`](slice::binary_search) instead of [`sort`](slice::sort)
/// and [`dedup`](Vec::dedup()).
///
/// # Safety
///
/// This function accepts any [`Box`]`<`[`Variant`]`>` that is expected to be a
/// valid list of sorted variants.
pub const unsafe fn from_raw_unchecked(input: Option<Box<[Variant]>>) -> Self {
Self(input)
Self(ShortVec::from(input))
}

/// Empties the [`Variants`] list.
Expand All @@ -153,7 +93,7 @@ impl Variants {
/// assert_eq!(variants.to_string(), "");
/// ```
pub fn clear(&mut self) {
self.0 = None;
self.0 = ShortVec::new();
}

pub(crate) fn for_each_subtag_str<E, F>(&self, f: &mut F) -> Result<(), E>
Expand All @@ -170,10 +110,6 @@ impl Deref for Variants {
type Target = [Variant];

fn deref(&self) -> &[Variant] {
if let Some(ref variants) = self.0 {
variants
} else {
&[]
}
self.0.as_slice()
}
}