Class RegoCliCompiler

Namespace

OpaDotNet.Compilation.Cli

Assembly

OpaDotNet.Compilation.Cli.dll

Compiles OPA bundle with opa cli tool.

public class RegoCliCompiler : IRegoCompiler

Inheritance

object

RegoCliCompiler

Implements

IRegoCompiler

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

RegoCliCompilerExtensions.CheckBundleAsync(RegoCliCompiler, Stream, CheckParameters)

RegoCliCompilerExtensions.CheckBundleAsync(RegoCliCompiler, Stream, CheckParameters, CancellationToken)

RegoCliCompilerExtensions.CheckBundleAsync(RegoCliCompiler, string, CheckParameters)

RegoCliCompilerExtensions.CheckBundleAsync(RegoCliCompiler, string, CheckParameters, CancellationToken)

RegoCliCompilerExtensions.CheckFileAsync(RegoCliCompiler, string, CheckParameters)

RegoCliCompilerExtensions.CheckFileAsync(RegoCliCompiler, string, CheckParameters, CancellationToken)

RegoCliCompilerExtensions.CheckSourceAsync(RegoCliCompiler, string, CheckParameters)

RegoCliCompilerExtensions.CheckSourceAsync(RegoCliCompiler, string, CheckParameters, CancellationToken)

Constructors

RegoCliCompiler(ILogger<RegoCliCompiler>?, RegoCliCompilerOptions?)

Creates new instance of RegoCliCompiler class.

public RegoCliCompiler(ILogger<RegoCliCompiler>? logger = null, RegoCliCompilerOptions? options = null)

Parameters

logger ILogger<RegoCliCompiler>

Logger instance

options RegoCliCompilerOptions

Compilation options

Methods

CheckAsync(Stream, CheckParameters, CancellationToken)

Check Rego sources for parse and compilation errors.

public Task<CheckResult> CheckAsync(Stream stream, CheckParameters parameters, CancellationToken cancellationToken)

Parameters

stream Stream

Source file or bundle stream.

parameters CheckParameters

Compiler parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<CheckResult>

Result of parsing and compiling the source file.

CheckAsync(string, CheckParameters, CancellationToken)

Check Rego sources for parse and compilation errors.

public Task<CheckResult> CheckAsync(string path, CheckParameters parameters, CancellationToken cancellationToken)

Parameters

path string

Source file or bundle path.

parameters CheckParameters

Compiler parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<CheckResult>

Result of parsing and compiling the source file.

Compile(Stream, CompilationParameters, CancellationToken)

Compiles OPA bundle from stream.

public Task<Stream> Compile(Stream stream, CompilationParameters parameters, CancellationToken cancellationToken)

Parameters

stream Stream

Source stream.

parameters CompilationParameters

Compilation parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<Stream>

Compiled OPA bundle stream.

Compile(string, CompilationParameters, CancellationToken)

Compiles OPA bundle from path.

public Task<Stream> Compile(string path, CompilationParameters parameters, CancellationToken cancellationToken)

Parameters

path string

Source path.

parameters CompilationParameters

Compilation parameters.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<Stream>

Compiled OPA bundle stream.

Version(CancellationToken)

Compiler version information.

public Task<RegoCompilerVersion> Version(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<RegoCompilerVersion>