YamlSettings Class

Summary

Base class for settings for YAML serialization and deserialization using YamlAliases.
Assembly
Cake.Yaml.dll
Namespace
Cake.Yaml
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type["YamlSettings"] class Type type-node Derived0["SerializeYamlSettings"]-->Type click Derived0 "/api/Cake.Yaml/SerializeYamlSettings" Derived1["DeserializeYamlSettings"]-->Type click Derived1 "/api/Cake.Yaml/DeserializeYamlSettings"

Syntax

public abstract class YamlSettings

Constructors

Name Summary
YamlSettings()

Properties

Name Value Summary
NamingConvention INamingConvention
The YamlDotNet.Serialization.INamingConvention that will be used by the (de)serializer.

Extension Methods

Name Value Summary
Dump<YamlSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<YamlSettings>(YamlSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<YamlSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<YamlSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<YamlSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<YamlSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin