std::alloc::System - Rust
Description: API documentation for the Rust `System` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, System

# 1.28.0[−]Struct std::alloc::System

    pub struct System;

The default memory allocator provided by the operating system.

This is based on `malloc` on Unix platforms and `HeapAlloc` on Windows, plus related functions.

This type can be used in a `static` item with the `#[global_allocator]` attribute to force the global allocator to be the system’s one. (The default is jemalloc for executables, on some platforms.)

    use std::alloc::System;

    #[global_allocator]
    static A: System = System;

    fn main() {
        let a = Box::new(4); // Allocates from the system allocator.
        println!("{}", a);
    }Run

It can also be used directly to allocate memory independently of the standard library’s global allocator.

## Trait Implementations

###

`impl Alloc for System`

####

`unsafe fn alloc(&mut self, layout: Layout) -> Result<NonNull<u8>, AllocErr>` |

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Returns a pointer meeting the size and alignment guarantees of `layout`. Read more

####

`unsafe fn alloc_zeroed( &mut self, layout: Layout ) -> Result<NonNull<u8>, AllocErr>` |

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Behaves like `alloc`, but also ensures that the contents are set to zero before being returned. Read more

####

`unsafe fn dealloc(&mut self, ptr: NonNull<u8>, layout: Layout)` |

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Deallocate the memory referenced by `ptr`. Read more

####

`unsafe fn realloc( &mut self, ptr: NonNull<u8>, layout: Layout, new_size: usize ) -> Result<NonNull<u8>, AllocErr>` |

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Returns a pointer suitable for holding data described by a new layout with `layout`’s alginment and a size given by `new_size`. To accomplish this, this may extend or shrink the allocation referenced by `ptr` to fit the new layout. Read more

####

`fn usable_size(&self, layout: &Layout) -> (usize, usize)`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Returns bounds on the guaranteed usable size of a successful allocation created with the specified `layout`. Read more

####

`unsafe fn alloc_excess(&mut self, layout: Layout) -> Result<Excess, AllocErr>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Behaves like `alloc`, but also returns the whole size of the returned block. For some `layout` inputs, like arrays, this may include extra storage usable for additional data. Read more

####

`unsafe fn realloc_excess( &mut self, ptr: NonNull<u8>, layout: Layout, new_size: usize ) -> Result<Excess, AllocErr>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Behaves like `realloc`, but also returns the whole size of the returned block. For some `layout` inputs, like arrays, this may include extra storage usable for additional data. Read more

####

`unsafe fn grow_in_place( &mut self, ptr: NonNull<u8>, layout: Layout, new_size: usize ) -> Result<(), CannotReallocInPlace>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Attempts to extend the allocation referenced by `ptr` to fit `new_size`. Read more

####

`unsafe fn shrink_in_place( &mut self, ptr: NonNull<u8>, layout: Layout, new_size: usize ) -> Result<(), CannotReallocInPlace>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Attempts to shrink the allocation referenced by `ptr` to fit `new_size`. Read more

####

`fn alloc_one<T>(&mut self) -> Result<NonNull<T>, AllocErr>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Allocates a block suitable for holding an instance of `T`. Read more

####

`unsafe fn dealloc_one<T>(&mut self, ptr: NonNull<T>)`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Deallocates a block suitable for holding an instance of `T`. Read more

####

`fn alloc_array<T>(&mut self, n: usize) -> Result<NonNull<T>, AllocErr>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Allocates a block suitable for holding `n` instances of `T`. Read more

####

`unsafe fn realloc_array<T>( &mut self, ptr: NonNull<T>, n_old: usize, n_new: usize ) -> Result<NonNull<T>, AllocErr>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Reallocates a block previously suitable for holding `n_old` instances of `T`, returning a block suitable for holding `n_new` instances of `T`. Read more

####

`unsafe fn dealloc_array<T>( &mut self, ptr: NonNull<T>, n: usize ) -> Result<(), AllocErr>`

[src]

🔬 This is a nightly-only experimental API. (`allocator_api` #32838)

Deallocates a block suitable for holding `n` instances of `T`. Read more

###

`impl GlobalAlloc for System`

####

`unsafe fn alloc(&self, layout: Layout) -> *mut u8` |

Allocate memory as described by the given `layout`. Read more

####

`unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8` |

Behaves like `alloc`, but also ensures that the contents are set to zero before being returned. Read more

####

`unsafe fn dealloc(&self, ptr: *mut u8, _layout: Layout)` |

Deallocate the block of memory at the given `ptr` pointer with the given `layout`. Read more

####

`unsafe fn realloc( &self, ptr: *mut u8, layout: Layout, new_size: usize ) -> *mut u8` |

Shink or grow a block of memory to the given `new_size`. The block is described by the given `ptr` pointer and `layout`. Read more

## Auto Trait Implementations

###

`impl Send for System`

###

`impl Sync for System`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)