Class ConfigurationAttribute

Namespace: Void.Proxy.Api.Configurations.Attributes
Assembly: Void.Proxy.Api.dll

Declares TOML metadata for a configuration root type.

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Interface)]
public class ConfigurationAttribute : Attribute

Inheritance

object ← Attribute ← ConfigurationAttribute

Inherited Members

Attribute.Equals(object?), Attribute.GetCustomAttribute(Assembly, Type), Attribute.GetCustomAttribute(Assembly, Type, bool), Attribute.GetCustomAttribute(MemberInfo, Type), Attribute.GetCustomAttribute(MemberInfo, Type, bool), Attribute.GetCustomAttribute(Module, Type), Attribute.GetCustomAttribute(Module, Type, bool), Attribute.GetCustomAttribute(ParameterInfo, Type), Attribute.GetCustomAttribute(ParameterInfo, Type, bool), Attribute.GetCustomAttributes(Assembly), Attribute.GetCustomAttributes(Assembly, bool), Attribute.GetCustomAttributes(Assembly, Type), Attribute.GetCustomAttributes(Assembly, Type, bool), Attribute.GetCustomAttributes(MemberInfo), Attribute.GetCustomAttributes(MemberInfo, bool), Attribute.GetCustomAttributes(MemberInfo, Type), Attribute.GetCustomAttributes(MemberInfo, Type, bool), Attribute.GetCustomAttributes(Module), Attribute.GetCustomAttributes(Module, bool), Attribute.GetCustomAttributes(Module, Type), Attribute.GetCustomAttributes(Module, Type, bool), Attribute.GetCustomAttributes(ParameterInfo), Attribute.GetCustomAttributes(ParameterInfo, bool), Attribute.GetCustomAttributes(ParameterInfo, Type), Attribute.GetCustomAttributes(ParameterInfo, Type, bool), Attribute.GetHashCode(), Attribute.IsDefaultAttribute(), Attribute.IsDefined(Assembly, Type), Attribute.IsDefined(Assembly, Type, bool), Attribute.IsDefined(MemberInfo, Type), Attribute.IsDefined(MemberInfo, Type, bool), Attribute.IsDefined(Module, Type), Attribute.IsDefined(Module, Type, bool), Attribute.IsDefined(ParameterInfo, Type), Attribute.IsDefined(ParameterInfo, Type, bool), Attribute.Match(object?), Attribute.TypeId, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Examples

[Configuration("network")]
public class NetworkConfiguration
{
}

Remarks

This attribute is read when resolving configuration file names and when projecting type-level TOML comments.

The value is treated as a logical alias and does not rename CLR members.

Constructors

ConfigurationAttribute(string)

Declares TOML metadata for a configuration root type.

public ConfigurationAttribute(string name)

Parameters

name string

Optional configuration name override used by the configuration file naming pipeline. When name is null, empty, or whitespace, consumers fall back to the CLR type name.

Examples

[Configuration("network")]
public class NetworkConfiguration
{
}

Remarks

This attribute is read when resolving configuration file names and when projecting type-level TOML comments.

The value is treated as a logical alias and does not rename CLR members.

See Also

RootConfigurationAttribute, ConfigurationPropertyAttribute

Properties

InlineComment

public string? InlineComment { get; init; }

Property Value

string?

Name

Gets the logical configuration name override declared for the decorated configuration type.

public string Name { get; init; }

Property Value

string

Examples

[Configuration("network")]
public sealed class NetworkConfiguration
{
}

Remarks

This value affects naming in configuration storage and does not rename CLR members or change type identity.

The property is init-only, so it can be assigned during attribute construction and object initialization.

See Also

ConfigurationAttribute, RootConfigurationAttribute

PrecedingComment

public string? PrecedingComment { get; init; }

Property Value

string?

See Also

RootConfigurationAttribute, ConfigurationPropertyAttribute