ProtobufTools Class

Assembly
Cake.ProtobufTools.dll
Namespace
Cake.ProtobufTools
Base Types
graph BT Type-->Base0["Tool<ProtocSettings>"] Type["ProtobufTools"] class Type type-node

Syntax

public class ProtobufTools : Tool<ProtocSettings>

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Name Summary
ProtobufTools(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator)

Methods

Name Value Summary
DirectoryFromTarget(OSTarget) string
Get's protoc directory based on target.
static
GetAlternativeToolPaths(ProtocSettings) IEnumerable<FilePath>
Finds the proper protoc executable path.
GetTarget(Nullable<OSTarget>, ICakePlatform) OSTarget
Automatically determines the OSTarget.
static
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
IsWindows(OSTarget) bool
Checks if target is Windows.
static
Run(ProtocSettings, string[]) void
Runs protoc using given settings and additional.

Extension Methods

Name Value Summary
Dump<ProtobufTools>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ProtobufTools>(ProtobufTools[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ProtobufTools>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ProtobufTools>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ProtobufTools>(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<ProtobufTools>(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