Struct EncLogBuilder 

pub struct EncLogBuilder { /* private fields */ }

Builder for constructing EncLog table entries

Provides a fluent interface for building EncLog metadata table entries. These entries track Edit-and-Continue operations performed during debugging sessions, recording which metadata elements were created, updated, or deleted.

Required Fields

• token_value: Metadata token identifying the affected element
• func_code: Operation code (0=create, 1=update, 2=delete)

Edit-and-Continue Context

The EncLog table is used by .NET’s Edit-and-Continue debugging feature to track all metadata changes made during debugging sessions. When developers modify code while debugging, the compiler generates new metadata and records the changes.

Examples

use dotscope::prelude::*;

// Record creation of a new method
let create_method = EncLogBuilder::new()
    .token_value(0x06000042)  // MethodDef token
    .func_code(0)             // Create operation
    .build(&mut assembly)?;

// Record update to an existing type
let update_type = EncLogBuilder::new()
    .token_value(0x02000010)  // TypeDef token
    .func_code(1)             // Update operation
    .build(&mut assembly)?;

// Record deletion of a field
let delete_field = EncLogBuilder::new()
    .token_value(0x04000025)  // Field token
    .func_code(2)             // Delete operation
    .build(&mut assembly)?;

Implementations

impl EncLogBuilder

pub fn new() -> Self

Creates a new EncLogBuilder with default values

Initializes a new builder instance with all fields unset. The caller must provide both required fields before calling build().

Returns

A new EncLogBuilder instance ready for configuration

Examples

use dotscope::prelude::*;

let builder = EncLogBuilder::new();

pub fn token_value(self, token_value: u32) -> Self

Sets the metadata token value

Specifies the metadata token that identifies which metadata element was affected by this Edit-and-Continue operation. The token format follows the standard structure: table_id (upper byte) + row_id (lower 3 bytes).

Parameters

• token_value: The metadata token identifying the affected element

Returns

Self for method chaining

Examples

use dotscope::prelude::*;

// Method token
let builder = EncLogBuilder::new()
    .token_value(0x06000001);  // MethodDef RID 1

// Type token
let builder = EncLogBuilder::new()
    .token_value(0x02000005);  // TypeDef RID 5

// Field token
let builder = EncLogBuilder::new()
    .token_value(0x04000010);  // Field RID 16

pub fn func_code(self, func_code: u32) -> Self

Sets the function code

Specifies the type of Edit-and-Continue operation that was performed on the metadata element identified by the token.

Parameters

• func_code: The operation code

Returns

Self for method chaining

Operation Codes

• 0: Create - New metadata item added during edit session
• 1: Update - Existing metadata item modified during edit session
• 2: Delete - Metadata item marked for deletion during edit session

Examples

use dotscope::prelude::*;

// Create operation
let builder = EncLogBuilder::new()
    .func_code(0);

// Update operation
let builder = EncLogBuilder::new()
    .func_code(1);

// Delete operation
let builder = EncLogBuilder::new()
    .func_code(2);

pub fn create(self) -> Self

Convenience method for create operations

Sets the function code to 0 (create) for new metadata items.

Returns

Self for method chaining

Examples

use dotscope::prelude::*;

let builder = EncLogBuilder::new()
    .create();  // Equivalent to .func_code(0)

pub fn update(self) -> Self

Convenience method for update operations

Sets the function code to 1 (update) for modified metadata items.

Returns

Self for method chaining

Examples

use dotscope::prelude::*;

let builder = EncLogBuilder::new()
    .update();  // Equivalent to .func_code(1)

pub fn delete(self) -> Self

Convenience method for delete operations

Sets the function code to 2 (delete) for removed metadata items.

Returns

Self for method chaining

Examples

use dotscope::prelude::*;

let builder = EncLogBuilder::new()
    .delete();  // Equivalent to .func_code(2)

pub fn build(self, assembly: &mut CilAssembly) -> Result<ChangeRefRc>

Builds and adds the EncLog entry to the metadata

Validates all required fields, creates the EncLog table entry, and adds it to the assembly. Returns a token that can be used to reference this edit log entry.

Parameters

• assembly: Mutable reference to the CilAssembly

Returns

• Ok(Token): Token referencing the created edit log entry
• Err(Error): If validation fails or table operations fail

Errors

• Missing required field (token_value or func_code)
• Table operations fail due to metadata constraints

Examples

use dotscope::prelude::*;

let mut assembly = CilAssembly::new(view);
let token = EncLogBuilder::new()
    .token_value(0x06000001)
    .func_code(1)
    .build(&mut assembly)?;

Trait Implementations

impl Clone for EncLogBuilder

fn clone(&self) -> EncLogBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncLogBuilder

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

Formats the value using the given formatter.

impl Default for EncLogBuilder

fn default() -> Self

Creates a default EncLogBuilder

Equivalent to calling EncLogBuilder::new().