std.experimental.allocator.gc_allocator - D Programming Language

Menu

- Learn
- Documentation
  - Language Reference
  - Library Reference
  - Command-line Reference
  - Feature Overview
  - Articles
- Downloads
- Packages
- Community
  - Blog
  - Orgs using D
  - Twitter
  - Calendar
  - Forums
  - IRC
  - Community Discord
  - Wiki
  - GitHub
  - Issues
  - Get involved
  - Contributors
  - Foundation
  - Security Team
  - Donate
  - Sponsors
- Resources
  - Tour
  - Books
  - Tutorials
  - Tools
  - Editors
  - IDEs
  - run.dlang.io
  - Visual D
  - Acknowledgments
  - D Style
  - Glossary
  - Sitemap

Search
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using a local clone.

# std.experimental.allocator.gc_allocator

D's built-in garbage-collected allocator.

Source std/experimental/allocator/gc_allocator.d

struct `GCAllocator`;
  D's built-in garbage-collected allocator.
  Examples:

      auto buffer = GCAllocator.instance.allocate(1024 * 1024 * 4);
      // deallocate upon scope's end (alternatively: leave it to collection)
      scope(exit) GCAllocator.instance.deallocate(buffer);
      //...

  enum uint `alignment`;
    The alignment is a static constant equal to platformAlignment, which ensures proper alignment for any D data type.
  shared const pure nothrow @trusted void[] `allocate`(size_t `bytes`);
  shared const pure nothrow @trusted bool `expand`(ref void[] `b`, size_t `delta`);
  shared const pure nothrow @system bool `reallocate`(ref void[] `b`, size_t `newSize`);
  shared const pure nothrow @nogc @trusted Ternary `resolveInternalPointer`(const void* `p`, ref void[] `result`);
  shared const pure nothrow @nogc @system bool `deallocate`(void[] `b`);
  shared const pure nothrow @nogc @safe size_t `goodAllocSize`(size_t `n`);
    Standard allocator methods per the semantics defined above. The deallocate and `reallocate` methods are @system because they may move memory around, leaving dangling pointers in user code.
  static shared const GCAllocator `instance`;
    Returns the global instance of this allocator type. The garbage collected allocator is thread-safe, therefore all of its methods and `instance` itself are shared.

Copyright © 1999-2022 by the D Language Foundation | Page generated by Ddoc on Tue May 3 07:30:17 2022