Lib.rs

Cargo Features

[dependencies]
object = { version = "0.36.5", default-features = false, features = ["read_core", "read", "write_core", "write_std", "write", "build_core", "build", "std", "compression", "unaligned", "archive", "coff", "elf", "macho", "pe", "wasm", "xcoff", "all", "cargo-all", "doc", "unstable", "unstable-all", "rustc-dep-of-std"] }

read_core build_core? doc? read

=======================================
Read/write features.

Core read support. You will need to enable some file formats too.

Affects object::read…

read default all? = archive, coff, elf, macho, pe, read_core, unaligned, xcoff

Read support for most file formats (including unaligned files).

write_core build_core? write_std?

Core write support. You will need to enable some file formats too.

Enables crc32fast, hashbrown, and indexmap

Affects object::write…

write_std build? doc? write? = std, write_core

Core write support with libstd features. You will need to enable some file formats too.

Enables std of optional crc32fast and optional indexmap

write all? = coff, elf, macho, pe, write_std, xcoff

Write support for all file formats, including libstd features.

build_core build? doc? = read_core, write_core

Core builder support. You will need to enable some file formats too.

Affects object::build…

build all? = build_core, elf, write_std

Builder support for all file formats.

std all? compression doc? write_std?

======================================= Misc features.

Enable things that require libstd. Currently, this provides an Error implementation.

Enables std of memchr

Affects util::StreamingBuffer…

compression default all? doc? = std

Enable decompression of compressed sections.
This feature is not required if you want to do your own decompression.

Enables flate2 and ruzstd

unaligned read

Treat all types as unaligned.
Normally types use the alignment required by the specifications, but sometimes files do not strictly follow the specifications.
This may be useful to enable when processing files for architectures that have no alignment constraints.

Affects endian::U16, endian::U32, endian::U64, endian::I16, endian::I32, endian::I64…

archive doc? read

=======================================
File format features.

Affects object::archive, read::archive…

coff doc? pe? read write?

Affects read::coff, write::coff, object::pe…

elf build? doc? read write?

Affects build::elf, object::elf, read::elf, read::NativeFile, read::NativeFile, write::elf…

macho doc? read write?

Affects object::macho, read::macho, read::NativeFile, read::NativeFile…

pe doc? read write? = coff

Affects read::pe, read::NativeFile, read::NativeFile, write::pe, object::pe…

wasm all? doc?

Enables wasmparser ^0.218.0

Affects read::wasm, read::NativeFile…

xcoff doc? read write?

Affects object::xcoff, read::xcoff…

default = compression, read

=======================================
By default, support all read features.

all unstable-all? = build, compression, read, std, wasm, write

======================================= Umbrella feature for enabling all user-facing features of this crate. Does not enable internal features like rustc-dep-of-std.

cargo-all

Use of --all-features is not supported.
This is a dummy feature to detect when --all-features is used.

doc = archive, build_core, coff, compression, elf, macho, pe, read_core, std, wasm, write_std, xcoff

=======================================
Documentation should be generated with everything in "all" except for "unaligned".

unstable unstable-all?

=======================================
Unstable features. Breaking changes in these features will not affect versioning.

unstable-all = all, unstable

rustc-dep-of-std = alloc, compiler_builtins, core

=======================================
Internal feature, only used when building as part of libstd, not part of the stable interface of this crate.

Enables rustc-dep-of-std of memchr

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

alloc rustc-dep-of-std?

Enables rustc-std-workspace-alloc

core rustc-dep-of-std?

Enables rustc-std-workspace-core

Internal feature, only used when building as part of libstd, not part of the stable interface of this crate.

compiler_builtins rustc-dep-of-std?