Struct Vec 

pub struct Vec<'alloc, T>(/* private fields */);

A Vec without Drop, which stores its data in the arena allocator.

No Drops

Objects allocated into Oxc memory arenas are never Dropped. Memory is released in bulk when the allocator is dropped, without dropping the individual objects in the arena.

Therefore, it would produce a memory leak if you allocated Drop types into the arena which own memory allocations outside the arena.

Static checks make this impossible to do. Vec::new_in and all other methods which create a Vec will refuse to compile if called with a Drop type.

Implementations

impl<'alloc, T> Vec<'alloc, T>

pub fn new_in(allocator: &'alloc Allocator) -> Vec<'alloc, T>

Constructs a new, empty Vec<T>.

The vector will not allocate until elements are pushed onto it.

Examples

use oxc_allocator::{Allocator, Vec};

let allocator = Allocator::default();

let mut vec: Vec<i32> = Vec::new_in(&allocator);
assert!(vec.is_empty());

pub fn with_capacity_in( capacity: usize, allocator: &'alloc Allocator, ) -> Vec<'alloc, T>

Constructs a new, empty Vec<T> with at least the specified capacity with the provided allocator.

The vector will be able to hold at least capacity elements without reallocating. This method is allowed to allocate for more elements than capacity. If capacity is 0, the vector will not allocate.

It is important to note that although the returned vector has the minimum capacity specified, the vector will have a zero length.

For Vec<T> where T is a zero-sized type, there will be no allocation and the capacity will always be u32::MAX.

Panics

Panics if the new capacity exceeds isize::MAX bytes.

Examples

use oxc_allocator::{Allocator, Vec};

let allocator = Allocator::default();

let mut vec = Vec::with_capacity_in(10, &allocator);

// The vector contains no items, even though it has capacity for more
assert_eq!(vec.len(), 0);
assert_eq!(vec.capacity(), 10);

// These are all done without reallocating...
for i in 0..10 {
    vec.push(i);
}
assert_eq!(vec.len(), 10);
assert_eq!(vec.capacity(), 10);

// ...but this may make the vector reallocate
vec.push(11);
assert_eq!(vec.len(), 11);
assert!(vec.capacity() >= 11);

// A vector of a zero-sized type will always over-allocate, since no
// allocation is necessary
let vec_units = Vec::<()>::with_capacity_in(10, &allocator);
assert_eq!(vec_units.capacity(), usize::MAX);

pub fn from_iter_in<I>(iter: I, allocator: &'alloc Allocator) -> Vec<'alloc, T>

where I: IntoIterator<Item = T>,

Create a new Vec whose elements are taken from an iterator and allocated in the given allocator.

This is behaviorially identical to FromIterator::from_iter.

pub fn from_array_in<const N: usize>( array: [T; N], allocator: &'alloc Allocator, ) -> Vec<'alloc, T>

Create a new Vec from a fixed-size array, allocated in the given allocator.

This is preferable to from_iter_in where source is an array, as size is statically known, and compiler is more likely to construct the values directly in arena, rather than constructing on stack and then copying to arena.

Examples

use oxc_allocator::{Allocator, Vec};

let allocator = Allocator::default();

let array: [u32; 4] = [1, 2, 3, 4];
let vec = Vec::from_array_in(array, &allocator);

pub fn into_boxed_slice(self) -> Box<'alloc, [T]>

Convert Vec<T> into [Box<[T]>].

Any spare capacity in the Vec is lost.

[Box<[T]>]: Box

pub fn into_bump_slice(self) -> &'alloc [T]

Converts Vec<T> into [&'alloc [T]].

Examples

use oxc_allocator::{Allocator, Vec};

let allocator = Allocator::default();

let mut vec = Vec::from_iter_in([1, 2, 3], &allocator);
let slice = vec.into_bump_slice();
assert_eq!(slice, [1, 2, 3]);

Trait Implementations

impl<'new_alloc, T, C> CloneIn<'new_alloc> for Vec<'_, T>

where T: CloneIn<'new_alloc, Cloned = C>, C: 'new_alloc,

type Cloned = Vec<'new_alloc, C>

The type of the cloned object.

fn clone_in( &self, allocator: &'new_alloc Allocator, ) -> <Vec<'_, T> as CloneIn<'new_alloc>>::Cloned

Clone self into the given allocator. allocator may be the same one that self is already in.

fn clone_in_with_semantic_ids( &self, allocator: &'new_alloc Allocator, ) -> <Vec<'_, T> as CloneIn<'new_alloc>>::Cloned

Almost identical as clone_in, but for some special type, it will also clone the semantic ids. Please use this method only if you make sure semantic info is synced with the ast node.

impl<T> ConcatElement for Vec<'_, T>

where T: ESTree,

Available on crate feature serialize only.

fn push_to_sequence<S>(&self, seq: &mut S)

where S: SequenceSerializer,

impl<T> ContentEq for Vec<'_, T>

where T: ContentEq,

Blanket implementation for oxc_allocator::Vec types

Warning

This implementation is slow compared to PartialEq for native types which are Copy (e.g. u32). Prefer comparing the 2 vectors using == if they contain such native types (e.g. Vec<u32>). https://godbolt.org/z/54on5sMWc

fn content_eq(&self, other: &Vec<'_, T>) -> bool

This method tests for contents of self and other to be equal.

fn content_ne(&self, other: &Self) -> bool

This method tests for contents of self and other not to be equal. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Debug for Vec<'_, T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'alloc, T> Deref for Vec<'alloc, T>

type Target = Vec<'alloc, T, Bump>

The resulting type after dereferencing.

fn deref(&self) -> &<Vec<'alloc, T> as Deref>::Target

Dereferences the value.

impl<'alloc, T> DerefMut for Vec<'alloc, T>

fn deref_mut(&mut self) -> &mut Vec<'alloc, T, Bump>

Mutably dereferences the value.

impl<'a, T> Dummy<'a> for Vec<'a, T>

fn dummy(allocator: &'a Allocator) -> Vec<'a, T>

Create a dummy Vec.

impl<T> ESTree for Vec<'_, T>

where T: ESTree,

Available on crate features serialize only.

fn serialize<S>(&self, serializer: S)

where S: Serializer,

impl<'a, T> From<Vec<'a, T>> for Box<'a, [T]>

where T: 'a,

fn from(v: Vec<'a, T>) -> Box<'a, [T]>

Converts to this type from the input type.

impl<T> Hash for Vec<'_, T>

where T: Hash,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, I> Index<I> for Vec<'_, T>

where I: SliceIndex<[T]>,

type Output = <I as SliceIndex<[T]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<Vec<'_, T> as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl<T, I> IndexMut<I> for Vec<'_, T>

where I: SliceIndex<[T]>,

fn index_mut(&mut self, index: I) -> &mut <Vec<'_, T> as Index<I>>::Output

Performs the mutable indexing (container[index]) operation.

impl<'i, T> IntoIterator for &'i Vec<'_, T>

type IntoIter = Iter<'i, T>

Which kind of iterator are we turning this into?

type Item = &'i T

The type of the elements being iterated over.

fn into_iter(self) -> <&'i Vec<'_, T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'i, T> IntoIterator for &'i mut Vec<'_, T>

type IntoIter = IterMut<'i, T>

Which kind of iterator are we turning this into?

type Item = &'i mut T

The type of the elements being iterated over.

fn into_iter(self) -> <&'i mut Vec<'_, T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'alloc, T> IntoIterator for Vec<'alloc, T>

type IntoIter = <Vec<'alloc, T, Bump> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> <Vec<'alloc, T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'alloc, T> PartialEq for Vec<'alloc, T>

where T: PartialEq,

fn eq(&self, other: &Vec<'alloc, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for Vec<'_, T>

where T: Serialize,

Available on crate features serialize only.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, T> TakeIn<'a> for Vec<'a, T>

fn take_in<A>(&mut self, allocator_accessor: A) -> Self

where A: AllocatorAccessor<'a>,

Replace node with a dummy.

fn take_in_box<A>(&mut self, allocator_accessor: A) -> Box<'a, Self>

where A: AllocatorAccessor<'a>,

Replace node with a boxed dummy.

impl<'alloc, T> Eq for Vec<'alloc, T>

where T: Eq,

impl<'alloc, T> StructuralPartialEq for Vec<'alloc, T>

impl<T> Sync for Vec<'_, T>

where T: Sync,

SAFETY: Even though Bump is not Sync, we can make Vec<T> Sync if T is Sync because:

1. No public methods allow access to the &Bump that Vec contains (in RawVec), so user cannot illegally obtain 2 &Bumps on different threads via Vec.

2. All internal methods which access the &Bump take a &mut self. &mut Vec cannot be transferred across threads, and nor can an owned Vec (Vec is not Send). Therefore these methods taking &mut self can be sure they’re not operating on a Vec which has been moved across threads.

Note: Vec CANNOT be Send, even if T is Send, because that would allow 2 Vecs on different threads to both allocate into same arena simultaneously. Bump is not thread-safe, and this would be undefined behavior.