Class HumlIgnoreDefaultsAttribute

Namespace

Huml.Net.Serialization

Assembly

Huml.Net.dll

Instructs the HUML serialiser to omit all properties of the decorated type when their runtime value equals the CLR default for their declared type.

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct, AllowMultiple = false, Inherited = true)]
public sealed class HumlIgnoreDefaultsAttribute : Attribute

Inheritance

object

Attribute

HumlIgnoreDefaultsAttribute

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)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Applying this attribute to a class or struct is equivalent to adding [HumlProperty(OmitIfDefault = true)] to every property on that type. It is intended for DTOs with many optional properties (e.g. patch payloads, diff objects) where per-property annotation would be repetitive boilerplate.

Precedence: per-property [HumlProperty(OmitIfDefault = true)] takes the highest priority and is evaluated independently before this class-level attribute. HumlOptions.DefaultIgnoreCondition is consulted last as the global fallback.

The attribute is inherited by derived classes (Inherited = true). A derived class whose base is decorated with [HumlIgnoreDefaults] will also suppress its own properties at their CLR default. However, decorating only the derived class does not retroactively suppress base-class properties.