Skip to main content

EmitOptions

Struct EmitOptions 

Source
pub struct EmitOptions<'a> {
    pub emit_debug_info: bool,
    pub debug_sources: Option<&'a BTreeMap<FileId, String>>,
}
Expand description

Codegen-facing knobs for one emit call. emit_debug_info is the only field today — a struct (not a bare bool parameter) so a future knob (e.g. a D7 “populate locals” toggle) doesn’t need another emit_with_* overload.

Fields§

§emit_debug_info: bool

Emit the SectionKind::DebugInfo section (docs/debugger-spec.md §2). false (the Default) reproduces today’s emit() behavior byte-for-byte — this is what the ship-policy ruling (§1.2) and the oracle-safety guarantee both depend on.

§debug_sources: Option<&'a BTreeMap<FileId, String>>

Source text per file, for the DebugInfo file table’s source_hash and line_starts (#3261). Only read when emit_debug_info is set, so a release compile never pays for gathering it.

The text must be exactly what the compiler consumed — the hash is a staleness detector and any normalisation applied here but not by a later reader (or vice versa) turns it into a permanent false alarm.

None (or a file missing from the map) means that file’s entry gets source_hash: 0 and no line index: the section is still valid and positions still resolve, but staleness cannot be detected and file:line lookups for that file are unavailable. Degrading rather than failing is deliberate — a debug artifact without the extras beats no debug artifact.

Trait Implementations§

Source§

impl<'a> Clone for EmitOptions<'a>

Source§

fn clone(&self) -> EmitOptions<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for EmitOptions<'a>

Source§

impl<'a> Debug for EmitOptions<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for EmitOptions<'a>

Source§

fn default() -> EmitOptions<'a>

Returns the “default value” for a type. Read more
Source§

impl<'a> Eq for EmitOptions<'a>

Source§

impl<'a> PartialEq for EmitOptions<'a>

Source§

fn eq(&self, other: &EmitOptions<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for EmitOptions<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for EmitOptions<'a>

§

impl<'a> RefUnwindSafe for EmitOptions<'a>

§

impl<'a> Send for EmitOptions<'a>

§

impl<'a> Sync for EmitOptions<'a>

§

impl<'a> Unpin for EmitOptions<'a>

§

impl<'a> UnsafeUnpin for EmitOptions<'a>

§

impl<'a> UnwindSafe for EmitOptions<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more