projectv1

package
v3.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ProjectService_Load_FullMethodName = "/runme.project.v1.ProjectService/Load"
)

Variables

View Source
var (
	LoadEventType_name = map[int32]string{
		0: "LOAD_EVENT_TYPE_UNSPECIFIED",
		1: "LOAD_EVENT_TYPE_STARTED_WALK",
		2: "LOAD_EVENT_TYPE_FOUND_DIR",
		3: "LOAD_EVENT_TYPE_FOUND_FILE",
		4: "LOAD_EVENT_TYPE_FINISHED_WALK",
		5: "LOAD_EVENT_TYPE_STARTED_PARSING_DOC",
		6: "LOAD_EVENT_TYPE_FINISHED_PARSING_DOC",
		7: "LOAD_EVENT_TYPE_FOUND_TASK",
		8: "LOAD_EVENT_TYPE_ERROR",
	}
	LoadEventType_value = map[string]int32{
		"LOAD_EVENT_TYPE_UNSPECIFIED":          0,
		"LOAD_EVENT_TYPE_STARTED_WALK":         1,
		"LOAD_EVENT_TYPE_FOUND_DIR":            2,
		"LOAD_EVENT_TYPE_FOUND_FILE":           3,
		"LOAD_EVENT_TYPE_FINISHED_WALK":        4,
		"LOAD_EVENT_TYPE_STARTED_PARSING_DOC":  5,
		"LOAD_EVENT_TYPE_FINISHED_PARSING_DOC": 6,
		"LOAD_EVENT_TYPE_FOUND_TASK":           7,
		"LOAD_EVENT_TYPE_ERROR":                8,
	}
)

Enum value maps for LoadEventType.

View Source
var File_runme_project_v1_project_proto protoreflect.FileDescriptor
View Source
var ProjectService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "runme.project.v1.ProjectService",
	HandlerType: (*ProjectServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Load",
			Handler:       _ProjectService_Load_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "runme/project/v1/project.proto",
}

ProjectService_ServiceDesc is the grpc.ServiceDesc for ProjectService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterProjectServiceServer

func RegisterProjectServiceServer(s grpc.ServiceRegistrar, srv ProjectServiceServer)

Types

type DirectoryProjectOptions

type DirectoryProjectOptions struct {

	// Path to a directory containing the project.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// If true, .gitignore file is ignored, as well as .git/info/exclude.
	SkipGitignore bool `protobuf:"varint,2,opt,name=skip_gitignore,json=skipGitignore,proto3" json:"skip_gitignore,omitempty"`
	// A list of file patterns, compatible with .gitignore syntax,
	// to ignore.
	IgnoreFilePatterns []string `protobuf:"bytes,3,rep,name=ignore_file_patterns,json=ignoreFilePatterns,proto3" json:"ignore_file_patterns,omitempty"`
	// If true, it disables lookuping up for .git folder
	// in the parent directories.
	SkipRepoLookupUpward bool `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DirectoryProjectOptions) Descriptor deprecated

func (*DirectoryProjectOptions) Descriptor() ([]byte, []int)

Deprecated: Use DirectoryProjectOptions.ProtoReflect.Descriptor instead.

func (*DirectoryProjectOptions) GetIgnoreFilePatterns

func (x *DirectoryProjectOptions) GetIgnoreFilePatterns() []string

func (*DirectoryProjectOptions) GetPath

func (x *DirectoryProjectOptions) GetPath() string

func (*DirectoryProjectOptions) GetSkipGitignore

func (x *DirectoryProjectOptions) GetSkipGitignore() bool

func (*DirectoryProjectOptions) GetSkipRepoLookupUpward

func (x *DirectoryProjectOptions) GetSkipRepoLookupUpward() bool

func (*DirectoryProjectOptions) ProtoMessage

func (*DirectoryProjectOptions) ProtoMessage()

func (*DirectoryProjectOptions) ProtoReflect

func (x *DirectoryProjectOptions) ProtoReflect() protoreflect.Message

func (*DirectoryProjectOptions) Reset

func (x *DirectoryProjectOptions) Reset()

func (*DirectoryProjectOptions) String

func (x *DirectoryProjectOptions) String() string

type FileProjectOptions

type FileProjectOptions struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*FileProjectOptions) Descriptor deprecated

func (*FileProjectOptions) Descriptor() ([]byte, []int)

Deprecated: Use FileProjectOptions.ProtoReflect.Descriptor instead.

func (*FileProjectOptions) GetPath

func (x *FileProjectOptions) GetPath() string

func (*FileProjectOptions) ProtoMessage

func (*FileProjectOptions) ProtoMessage()

func (*FileProjectOptions) ProtoReflect

func (x *FileProjectOptions) ProtoReflect() protoreflect.Message

func (*FileProjectOptions) Reset

func (x *FileProjectOptions) Reset()

func (*FileProjectOptions) String

func (x *FileProjectOptions) String() string

type LoadEventError

type LoadEventError struct {
	ErrorMessage string `protobuf:"bytes,1,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadEventError) Descriptor deprecated

func (*LoadEventError) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventError.ProtoReflect.Descriptor instead.

func (*LoadEventError) GetErrorMessage

func (x *LoadEventError) GetErrorMessage() string

func (*LoadEventError) ProtoMessage

func (*LoadEventError) ProtoMessage()

func (*LoadEventError) ProtoReflect

func (x *LoadEventError) ProtoReflect() protoreflect.Message

func (*LoadEventError) Reset

func (x *LoadEventError) Reset()

func (*LoadEventError) String

func (x *LoadEventError) String() string

type LoadEventFinishedParsingDoc

type LoadEventFinishedParsingDoc struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadEventFinishedParsingDoc) Descriptor deprecated

func (*LoadEventFinishedParsingDoc) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventFinishedParsingDoc.ProtoReflect.Descriptor instead.

func (*LoadEventFinishedParsingDoc) GetPath

func (x *LoadEventFinishedParsingDoc) GetPath() string

func (*LoadEventFinishedParsingDoc) ProtoMessage

func (*LoadEventFinishedParsingDoc) ProtoMessage()

func (*LoadEventFinishedParsingDoc) ProtoReflect

func (*LoadEventFinishedParsingDoc) Reset

func (x *LoadEventFinishedParsingDoc) Reset()

func (*LoadEventFinishedParsingDoc) String

func (x *LoadEventFinishedParsingDoc) String() string

type LoadEventFinishedWalk

type LoadEventFinishedWalk struct {
	// contains filtered or unexported fields
}

func (*LoadEventFinishedWalk) Descriptor deprecated

func (*LoadEventFinishedWalk) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventFinishedWalk.ProtoReflect.Descriptor instead.

func (*LoadEventFinishedWalk) ProtoMessage

func (*LoadEventFinishedWalk) ProtoMessage()

func (*LoadEventFinishedWalk) ProtoReflect

func (x *LoadEventFinishedWalk) ProtoReflect() protoreflect.Message

func (*LoadEventFinishedWalk) Reset

func (x *LoadEventFinishedWalk) Reset()

func (*LoadEventFinishedWalk) String

func (x *LoadEventFinishedWalk) String() string

type LoadEventFoundDir

type LoadEventFoundDir struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadEventFoundDir) Descriptor deprecated

func (*LoadEventFoundDir) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventFoundDir.ProtoReflect.Descriptor instead.

func (*LoadEventFoundDir) GetPath

func (x *LoadEventFoundDir) GetPath() string

func (*LoadEventFoundDir) ProtoMessage

func (*LoadEventFoundDir) ProtoMessage()

func (*LoadEventFoundDir) ProtoReflect

func (x *LoadEventFoundDir) ProtoReflect() protoreflect.Message

func (*LoadEventFoundDir) Reset

func (x *LoadEventFoundDir) Reset()

func (*LoadEventFoundDir) String

func (x *LoadEventFoundDir) String() string

type LoadEventFoundFile

type LoadEventFoundFile struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadEventFoundFile) Descriptor deprecated

func (*LoadEventFoundFile) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventFoundFile.ProtoReflect.Descriptor instead.

func (*LoadEventFoundFile) GetPath

func (x *LoadEventFoundFile) GetPath() string

func (*LoadEventFoundFile) ProtoMessage

func (*LoadEventFoundFile) ProtoMessage()

func (*LoadEventFoundFile) ProtoReflect

func (x *LoadEventFoundFile) ProtoReflect() protoreflect.Message

func (*LoadEventFoundFile) Reset

func (x *LoadEventFoundFile) Reset()

func (*LoadEventFoundFile) String

func (x *LoadEventFoundFile) String() string

type LoadEventFoundTask

type LoadEventFoundTask struct {
	DocumentPath    string `protobuf:"bytes,1,opt,name=document_path,json=documentPath,proto3" json:"document_path,omitempty"`
	Id              string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Name            string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	IsNameGenerated bool   `protobuf:"varint,4,opt,name=is_name_generated,json=isNameGenerated,proto3" json:"is_name_generated,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadEventFoundTask) Descriptor deprecated

func (*LoadEventFoundTask) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventFoundTask.ProtoReflect.Descriptor instead.

func (*LoadEventFoundTask) GetDocumentPath

func (x *LoadEventFoundTask) GetDocumentPath() string

func (*LoadEventFoundTask) GetId

func (x *LoadEventFoundTask) GetId() string

func (*LoadEventFoundTask) GetIsNameGenerated

func (x *LoadEventFoundTask) GetIsNameGenerated() bool

func (*LoadEventFoundTask) GetName

func (x *LoadEventFoundTask) GetName() string

func (*LoadEventFoundTask) ProtoMessage

func (*LoadEventFoundTask) ProtoMessage()

func (*LoadEventFoundTask) ProtoReflect

func (x *LoadEventFoundTask) ProtoReflect() protoreflect.Message

func (*LoadEventFoundTask) Reset

func (x *LoadEventFoundTask) Reset()

func (*LoadEventFoundTask) String

func (x *LoadEventFoundTask) String() string

type LoadEventStartedParsingDoc

type LoadEventStartedParsingDoc struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadEventStartedParsingDoc) Descriptor deprecated

func (*LoadEventStartedParsingDoc) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventStartedParsingDoc.ProtoReflect.Descriptor instead.

func (*LoadEventStartedParsingDoc) GetPath

func (x *LoadEventStartedParsingDoc) GetPath() string

func (*LoadEventStartedParsingDoc) ProtoMessage

func (*LoadEventStartedParsingDoc) ProtoMessage()

func (*LoadEventStartedParsingDoc) ProtoReflect

func (*LoadEventStartedParsingDoc) Reset

func (x *LoadEventStartedParsingDoc) Reset()

func (*LoadEventStartedParsingDoc) String

func (x *LoadEventStartedParsingDoc) String() string

type LoadEventStartedWalk

type LoadEventStartedWalk struct {
	// contains filtered or unexported fields
}

func (*LoadEventStartedWalk) Descriptor deprecated

func (*LoadEventStartedWalk) Descriptor() ([]byte, []int)

Deprecated: Use LoadEventStartedWalk.ProtoReflect.Descriptor instead.

func (*LoadEventStartedWalk) ProtoMessage

func (*LoadEventStartedWalk) ProtoMessage()

func (*LoadEventStartedWalk) ProtoReflect

func (x *LoadEventStartedWalk) ProtoReflect() protoreflect.Message

func (*LoadEventStartedWalk) Reset

func (x *LoadEventStartedWalk) Reset()

func (*LoadEventStartedWalk) String

func (x *LoadEventStartedWalk) String() string

type LoadEventType

type LoadEventType int32
const (
	LoadEventType_LOAD_EVENT_TYPE_UNSPECIFIED          LoadEventType = 0
	LoadEventType_LOAD_EVENT_TYPE_STARTED_WALK         LoadEventType = 1
	LoadEventType_LOAD_EVENT_TYPE_FOUND_DIR            LoadEventType = 2
	LoadEventType_LOAD_EVENT_TYPE_FOUND_FILE           LoadEventType = 3
	LoadEventType_LOAD_EVENT_TYPE_FINISHED_WALK        LoadEventType = 4
	LoadEventType_LOAD_EVENT_TYPE_STARTED_PARSING_DOC  LoadEventType = 5
	LoadEventType_LOAD_EVENT_TYPE_FINISHED_PARSING_DOC LoadEventType = 6
	LoadEventType_LOAD_EVENT_TYPE_FOUND_TASK           LoadEventType = 7
	LoadEventType_LOAD_EVENT_TYPE_ERROR                LoadEventType = 8
)

func (LoadEventType) Descriptor

func (LoadEventType) Enum

func (x LoadEventType) Enum() *LoadEventType

func (LoadEventType) EnumDescriptor deprecated

func (LoadEventType) EnumDescriptor() ([]byte, []int)

Deprecated: Use LoadEventType.Descriptor instead.

func (LoadEventType) Number

func (LoadEventType) String

func (x LoadEventType) String() string

func (LoadEventType) Type

type LoadRequest

type LoadRequest struct {

	// Types that are assignable to Kind:
	//
	//	*LoadRequest_Directory
	//	*LoadRequest_File
	Kind     isLoadRequest_Kind `protobuf_oneof:"kind"`
	Identity v1.RunmeIdentity   `protobuf:"varint,3,opt,name=identity,proto3,enum=runme.parser.v1.RunmeIdentity" json:"identity,omitempty"`
	// contains filtered or unexported fields
}

func (*LoadRequest) Descriptor deprecated

func (*LoadRequest) Descriptor() ([]byte, []int)

Deprecated: Use LoadRequest.ProtoReflect.Descriptor instead.

func (*LoadRequest) GetDirectory

func (x *LoadRequest) GetDirectory() *DirectoryProjectOptions

func (*LoadRequest) GetFile

func (x *LoadRequest) GetFile() *FileProjectOptions

func (*LoadRequest) GetIdentity

func (x *LoadRequest) GetIdentity() v1.RunmeIdentity

func (*LoadRequest) GetKind

func (m *LoadRequest) GetKind() isLoadRequest_Kind

func (*LoadRequest) ProtoMessage

func (*LoadRequest) ProtoMessage()

func (*LoadRequest) ProtoReflect

func (x *LoadRequest) ProtoReflect() protoreflect.Message

func (*LoadRequest) Reset

func (x *LoadRequest) Reset()

func (*LoadRequest) String

func (x *LoadRequest) String() string

type LoadRequest_Directory

type LoadRequest_Directory struct {
	Directory *DirectoryProjectOptions `protobuf:"bytes,1,opt,name=directory,proto3,oneof"`
}

type LoadRequest_File

type LoadRequest_File struct {
	File *FileProjectOptions `protobuf:"bytes,2,opt,name=file,proto3,oneof"`
}

type LoadResponse

type LoadResponse struct {
	Type LoadEventType `protobuf:"varint,1,opt,name=type,proto3,enum=runme.project.v1.LoadEventType" json:"type,omitempty"`
	// Types that are assignable to Data:
	//
	//	*LoadResponse_StartedWalk
	//	*LoadResponse_FoundDir
	//	*LoadResponse_FoundFile
	//	*LoadResponse_FinishedWalk
	//	*LoadResponse_StartedParsingDoc
	//	*LoadResponse_FinishedParsingDoc
	//	*LoadResponse_FoundTask
	//	*LoadResponse_Error
	Data isLoadResponse_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

func (*LoadResponse) Descriptor deprecated

func (*LoadResponse) Descriptor() ([]byte, []int)

Deprecated: Use LoadResponse.ProtoReflect.Descriptor instead.

func (*LoadResponse) GetData

func (m *LoadResponse) GetData() isLoadResponse_Data

func (*LoadResponse) GetError

func (x *LoadResponse) GetError() *LoadEventError

func (*LoadResponse) GetFinishedParsingDoc

func (x *LoadResponse) GetFinishedParsingDoc() *LoadEventFinishedParsingDoc

func (*LoadResponse) GetFinishedWalk

func (x *LoadResponse) GetFinishedWalk() *LoadEventFinishedWalk

func (*LoadResponse) GetFoundDir

func (x *LoadResponse) GetFoundDir() *LoadEventFoundDir

func (*LoadResponse) GetFoundFile

func (x *LoadResponse) GetFoundFile() *LoadEventFoundFile

func (*LoadResponse) GetFoundTask

func (x *LoadResponse) GetFoundTask() *LoadEventFoundTask

func (*LoadResponse) GetStartedParsingDoc

func (x *LoadResponse) GetStartedParsingDoc() *LoadEventStartedParsingDoc

func (*LoadResponse) GetStartedWalk

func (x *LoadResponse) GetStartedWalk() *LoadEventStartedWalk

func (*LoadResponse) GetType

func (x *LoadResponse) GetType() LoadEventType

func (*LoadResponse) ProtoMessage

func (*LoadResponse) ProtoMessage()

func (*LoadResponse) ProtoReflect

func (x *LoadResponse) ProtoReflect() protoreflect.Message

func (*LoadResponse) Reset

func (x *LoadResponse) Reset()

func (*LoadResponse) String

func (x *LoadResponse) String() string

type LoadResponse_Error

type LoadResponse_Error struct {
	Error *LoadEventError `protobuf:"bytes,9,opt,name=error,proto3,oneof"`
}

type LoadResponse_FinishedParsingDoc

type LoadResponse_FinishedParsingDoc struct {
	FinishedParsingDoc *LoadEventFinishedParsingDoc `protobuf:"bytes,7,opt,name=finished_parsing_doc,json=finishedParsingDoc,proto3,oneof"`
}

type LoadResponse_FinishedWalk

type LoadResponse_FinishedWalk struct {
	FinishedWalk *LoadEventFinishedWalk `protobuf:"bytes,5,opt,name=finished_walk,json=finishedWalk,proto3,oneof"`
}

type LoadResponse_FoundDir

type LoadResponse_FoundDir struct {
	FoundDir *LoadEventFoundDir `protobuf:"bytes,3,opt,name=found_dir,json=foundDir,proto3,oneof"`
}

type LoadResponse_FoundFile

type LoadResponse_FoundFile struct {
	FoundFile *LoadEventFoundFile `protobuf:"bytes,4,opt,name=found_file,json=foundFile,proto3,oneof"`
}

type LoadResponse_FoundTask

type LoadResponse_FoundTask struct {
	FoundTask *LoadEventFoundTask `protobuf:"bytes,8,opt,name=found_task,json=foundTask,proto3,oneof"`
}

type LoadResponse_StartedParsingDoc

type LoadResponse_StartedParsingDoc struct {
	StartedParsingDoc *LoadEventStartedParsingDoc `protobuf:"bytes,6,opt,name=started_parsing_doc,json=startedParsingDoc,proto3,oneof"`
}

type LoadResponse_StartedWalk

type LoadResponse_StartedWalk struct {
	StartedWalk *LoadEventStartedWalk `protobuf:"bytes,2,opt,name=started_walk,json=startedWalk,proto3,oneof"`
}

type ProjectServiceClient

type ProjectServiceClient interface {
	// Load creates a new project, walks it, and streams events
	// about found directories, files, and code blocks.
	Load(ctx context.Context, in *LoadRequest, opts ...grpc.CallOption) (ProjectService_LoadClient, error)
}

ProjectServiceClient is the client API for ProjectService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type ProjectServiceServer

type ProjectServiceServer interface {
	// Load creates a new project, walks it, and streams events
	// about found directories, files, and code blocks.
	Load(*LoadRequest, ProjectService_LoadServer) error
	// contains filtered or unexported methods
}

ProjectServiceServer is the server API for ProjectService service. All implementations must embed UnimplementedProjectServiceServer for forward compatibility

type ProjectService_LoadClient

type ProjectService_LoadClient interface {
	Recv() (*LoadResponse, error)
	grpc.ClientStream
}

type ProjectService_LoadServer

type ProjectService_LoadServer interface {
	Send(*LoadResponse) error
	grpc.ServerStream
}

type UnimplementedProjectServiceServer

type UnimplementedProjectServiceServer struct {
}

UnimplementedProjectServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedProjectServiceServer) Load

type UnsafeProjectServiceServer

type UnsafeProjectServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeProjectServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ProjectServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL