This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.ProtobufTools.
Summary
Settings for protoc.
- Assembly
- Cake
.ProtobufTools .dll - Namespace
- Cake
.ProtobufTools - Base Types
-
- ToolSettings
- AutoToolSettings
graph BT
Type-->Base0["AutoToolSettings"]
click Base0 "/api/Cake.ProtobufTools/AutoToolSettings"
Base0-->Base1["ToolSettings"]
Type["ProtocSettings"]
class Type type-node
Syntax
public class ProtocSettings : AutoToolSettings
Attributes
Type | Description |
---|---|
Nullable |
|
NullableAttribute |
Constructors
Name | Summary |
---|---|
ProtocSettings |
Properties
Name | Value | Summary |
---|---|---|
CppOut | string |
Generate C++ header and source.
|
CSharpOut | string |
Generate C# source file.
|
Decode | string |
Read a binary message of the given type from
standard input and write it in text format
to standard output.The message type must
be defined in PROTO_FILES or their imports.
|
DecodeRaw | Nullable |
Read an arbitrary protocol message from
standard input and write the raw tag/value
pairs in text format to standard output.No
PROTO_FILES should be given when using this
flag.
|
DependencyOut | string |
Write a dependency output file in the format
expected by make.This writes the transitive
set of input file paths to FILE
|
DescriptorSetIn | string |
Specifies a delimited list of FILES
each containing a FileDescriptorSet(a
protocol buffer defined in descriptor.proto).
The FileDescriptor for each of the PROTO_FILES
provided will be loaded from these
FileDescriptorSets.If a FileDescriptor
appears multiple times, the first occurrence
will be used.
|
DescriptorSetOut | string |
Writes a FileDescriptorSet (a protocol buffer, defined in descriptor.proto) containing all of
the input files to FILE.
|
Encode | string |
Read a text-format message of the given type
from standard input and write it in binary
to standard output.The message type must
be defined in PROTO_FILES or their imports.
|
ErrorFormat | string |
Set the format in which to print errors.
FORMAT may be 'gcc' (the default) or 'msvs'
(Microsoft Visual Studio format).
|
IncludeImports | Nullable |
When using --descriptor_set_out, also include
all dependencies of the input files in the
set, so that the set is self-contained.
|
IncludeSourceInfo | Nullable |
When using --descriptor_set_out, do not strip
SourceCodeInfo from the FileDescriptorProto.
This results in vastly larger descriptors that
include information about the original
location of each decl in the source file as
well as surrounding comments.
|
JavananoOut | string |
Generate Java Nano source file.
|
JavaOut | string |
Generate Java source file.
|
JsOut | string |
Generate JavaScript source file.
|
ObjcOut | string |
Generate ObjectiveC header and source.
|
OFile | Nullable |
Writes a FileDescriptorSet (a protocol buffer, defined in descriptor.proto) containing all of
the input files to FILE.
|
OSTarget | Nullable |
Specifies what protoc executable will run.
|
PhpOut | string |
Generate PHP source file.
|
Plugin | string |
Specifies a plugin executable to use.
Normally, protoc searches the PATH for
plugins, but you may specify additional
executables not in the path using this flag.
Additionally, EXECUTABLE may be of the form
NAME= PATH, in which case the given plugin name
is mapped to the given executable even if
the executable's own name differs.
|
Print |
Nullable |
Print the free field numbers of the messages
defined in the given proto files.Groups share
the same field number space with the parent
message. Extension ranges are counted as
occupied fields numbers.
|
ProtoPath | string |
Specify the directory in which to search for
imports.May be specified multiple times;
directories will be searched in order.If not
given, the current working directory is used.
|
PythonOut | string |
Generate Python source file.
|
RubyOut | string |
Generate Ruby source file.
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|