Struct PermissionSetBuilder 

pub struct PermissionSetBuilder { /* private fields */ }

Builder for creating permission sets with fluent API.

The crate::metadata::security::builders::PermissionSetBuilder provides a convenient way to build permission sets programmatically with type-safe operations and validation. It follows the builder pattern to enable readable and maintainable permission set construction for .NET Code Access Security.

Design Benefits

• Fluent Interface: Method chaining for readable permission construction
• Type Safety: Each permission builder validates its specific constraints
• Composition: Easily combine multiple permission types in a single set
• Encoding Integration: Direct encoding to binary or XML formats
• Extensibility: Support for custom permissions alongside built-in types

Usage Examples

use dotscope::metadata::security::{PermissionSetBuilder, PermissionSetFormat};

// Create a simple unrestricted permission set
let permission_bytes = PermissionSetBuilder::new()
    .add_security_permission()
        .unrestricted(true)
        .build()
    .encode(PermissionSetFormat::BinaryLegacy)?;

Thread Safety

This type is not Send or Sync because it contains mutable state for building permissions. Use within a single thread and encode the result for cross-thread sharing.

Implementations

impl PermissionSetBuilder

pub fn new() -> Self

Creates a new permission set builder.

Initializes an empty permission set builder ready to accept permission configurations. The builder starts with no permissions and can be populated using the various add_* methods or by directly adding crate::metadata::security::Permission instances.

Returns

Returns a new crate::metadata::security::builders::PermissionSetBuilder instance ready for permission addition.

Examples

use dotscope::metadata::security::PermissionSetBuilder;

let builder = PermissionSetBuilder::new();
assert_eq!(builder.permissions().len(), 0);

pub fn add_permission(self, permission: Permission) -> Self

Adds a custom permission to the set.

Directly adds a pre-constructed crate::metadata::security::Permission to the permission set. This method is useful for adding custom permission types that don’t have dedicated builder methods, or when you need full control over permission construction.

Arguments

• permission - A fully constructed crate::metadata::security::Permission instance to add

Returns

Returns the builder instance for method chaining.

Examples

use dotscope::metadata::security::{
    PermissionSetBuilder, Permission, NamedArgument, ArgumentType, ArgumentValue
};

let custom_permission = Permission {
    class_name: "CustomNamespace.CustomPermission".to_string(),
    assembly_name: "CustomAssembly".to_string(),
    named_arguments: vec![
        NamedArgument {
            name: "Level".to_string(),
            arg_type: ArgumentType::Int32,
            value: ArgumentValue::Int32(5),
        }
    ],
};

let builder = PermissionSetBuilder::new()
    .add_permission(custom_permission);

pub fn add_security_permission(self) -> SecurityPermissionBuilder

Starts building a SecurityPermission.

Creates a new crate::metadata::security::builders::SecurityPermissionBuilder for configuring a System.Security.Permissions.SecurityPermission instance. This permission type controls fundamental security operations like skipping verification, controlling policy, and managing evidence.

Returns

Returns a crate::metadata::security::builders::SecurityPermissionBuilder for configuring security permissions.

Examples

use dotscope::metadata::security::PermissionSetBuilder;

let builder = PermissionSetBuilder::new()
    .add_security_permission()
        .flags("Execution, SkipVerification")
        .build();

pub fn add_file_io_permission(self) -> FileIOPermissionBuilder

Starts building a FileIOPermission.

Creates a new crate::metadata::security::builders::FileIOPermissionBuilder for configuring a System.Security.Permissions.FileIOPermission instance. This permission type controls file system access including read, write, and append operations on specific paths or with unrestricted access.

Returns

Returns a crate::metadata::security::builders::FileIOPermissionBuilder for configuring file I/O permissions.

Examples

use dotscope::metadata::security::PermissionSetBuilder;

let builder = PermissionSetBuilder::new()
    .add_file_io_permission()
        .read_paths(&["C:\\Data"])
        .write_paths(&["C:\\Logs"])
        .build();

pub fn encode(self, format: PermissionSetFormat) -> Result<Vec<u8>>

Encodes the permission set to the specified format.

Converts the built permission set to binary representation using the specified format. This method consumes the builder and delegates to crate::metadata::security::encode_permission_set for the actual encoding process.

Arguments

• format - The target crate::metadata::security::PermissionSetFormat for encoding

Returns

Returns the encoded permission set as a byte vector, or an error if encoding fails.

Errors

Returns crate::Error in the following cases:

• [crate::Error::Malformed] - When permission data contains unsupported types
• [crate::Error::Malformed] - When the target format is crate::metadata::security::PermissionSetFormat::Unknown

Examples

use dotscope::metadata::security::{PermissionSetBuilder, PermissionSetFormat};

let binary_data = PermissionSetBuilder::new()
    .add_security_permission()
        .unrestricted(true)
        .build()
    .encode(PermissionSetFormat::BinaryLegacy)?;

let xml_data = PermissionSetBuilder::new()
    .add_security_permission()
        .unrestricted(true)
        .build()
    .encode(PermissionSetFormat::Xml)?;

pub fn permissions(self) -> Vec<Permission>

Gets the built permissions.

Consumes the builder and returns the constructed permission collection. This method is useful when you need access to the permission structures without encoding them, such as for further processing or validation.

Returns

Returns a vector of crate::metadata::security::Permission instances that were built.

Examples

use dotscope::metadata::security::PermissionSetBuilder;

let permissions = PermissionSetBuilder::new()
    .add_security_permission()
        .unrestricted(true)
        .build()
    .permissions();

assert_eq!(permissions.len(), 1);
assert_eq!(permissions[0].class_name, "System.Security.Permissions.SecurityPermission");

Trait Implementations

impl Default for PermissionSetBuilder

fn default() -> Self

Returns the “default value” for a type.