docutil

package
v0.0.0-...-53bcd79 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2025 License: MIT Imports: 36 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	FileType_name = map[int32]string{
		0: "FILE_TYPE_MARKDOWN",
	}
	FileType_value = map[string]int32{
		"FILE_TYPE_MARKDOWN": 0,
	}
)

Enum value maps for FileType.

View Source 
var (
	LinkType_name = map[int32]string{
		0: "LINK_TYPE_EXTERNAL",
		1: "LINK_TYPE_IN_REPOSITORY",
		2: "LINK_TYPE_NEIGHBOR_REPOSITORY",
	}
	LinkType_value = map[string]int32{
		"LINK_TYPE_EXTERNAL":            0,
		"LINK_TYPE_IN_REPOSITORY":       1,
		"LINK_TYPE_NEIGHBOR_REPOSITORY": 2,
	}
)

Enum value maps for LinkType.

View Source 
var File_proto_docutil_search_proto protoreflect.FileDescriptor

Functions

func RegisterDocSearchServer 

func RegisterDocSearchServer(s *grpc.Server, srv DocSearchServer)

Types

type DirectoryEntry 

type DirectoryEntry struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Path  string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	IsDir bool   `protobuf:"varint,3,opt,name=is_dir,json=isDir,proto3" json:"is_dir,omitempty"`
	// contains filtered or unexported fields
}

func (*DirectoryEntry) Descriptor deprecated 

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

Deprecated: Use DirectoryEntry.ProtoReflect.Descriptor instead.

func (*DirectoryEntry) GetIsDir 

func (x *DirectoryEntry) GetIsDir() bool

func (*DirectoryEntry) GetName 

func (x *DirectoryEntry) GetName() string

func (*DirectoryEntry) GetPath 

func (x *DirectoryEntry) GetPath() string

func (*DirectoryEntry) ProtoMessage 

func (*DirectoryEntry) ProtoMessage()

func (*DirectoryEntry) ProtoReflect 

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

func (*DirectoryEntry) Reset 

func (x *DirectoryEntry) Reset()

func (*DirectoryEntry) String 

func (x *DirectoryEntry) String() string

type DocSearchClient 

type DocSearchClient interface {
	AvailableFeatures(ctx context.Context, in *RequestAvailableFeatures, opts ...grpc.CallOption) (*ResponseAvailableFeatures, error)
	ListRepository(ctx context.Context, in *RequestListRepository, opts ...grpc.CallOption) (*ResponseListRepository, error)
	GetRepository(ctx context.Context, in *RequestGetRepository, opts ...grpc.CallOption) (*ResponseGetRepository, error)
	GetPage(ctx context.Context, in *RequestGetPage, opts ...grpc.CallOption) (*ResponseGetPage, error)
	PageLink(ctx context.Context, in *RequestPageLink, opts ...grpc.CallOption) (*ResponsePageLink, error)
	GetDirectory(ctx context.Context, in *RequestGetDirectory, opts ...grpc.CallOption) (*ResponseGetDirectory, error)
}

DocSearchClient is the client API for DocSearch service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDocSearchClient 

func NewDocSearchClient(cc grpc.ClientConnInterface) DocSearchClient

type DocSearchServer 

type DocSearchServer interface {
	AvailableFeatures(context.Context, *RequestAvailableFeatures) (*ResponseAvailableFeatures, error)
	ListRepository(context.Context, *RequestListRepository) (*ResponseListRepository, error)
	GetRepository(context.Context, *RequestGetRepository) (*ResponseGetRepository, error)
	GetPage(context.Context, *RequestGetPage) (*ResponseGetPage, error)
	PageLink(context.Context, *RequestPageLink) (*ResponsePageLink, error)
	GetDirectory(context.Context, *RequestGetDirectory) (*ResponseGetDirectory, error)
}

DocSearchServer is the server API for DocSearch service.

type DocSearchService 

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

func NewDocSearchService 

func NewDocSearchService(client git.GitDataClient, b ObjectStorageInterface) *DocSearchService

func (*DocSearchService) AvailableFeatures 

func (d *DocSearchService) AvailableFeatures(_ context.Context, _ *RequestAvailableFeatures) (*ResponseAvailableFeatures, error)

func (*DocSearchService) GetDirectory 

func (d *DocSearchService) GetDirectory(_ context.Context, req *RequestGetDirectory) (*ResponseGetDirectory, error)

func (*DocSearchService) GetPage 

func (d *DocSearchService) GetPage(_ context.Context, req *RequestGetPage) (*ResponseGetPage, error)

func (*DocSearchService) GetRepository 

func (d *DocSearchService) GetRepository(_ context.Context, req *RequestGetRepository) (*ResponseGetRepository, error)

func (*DocSearchService) Initialize 

func (d *DocSearchService) Initialize(ctx context.Context, workers, maxConns int) error

func (*DocSearchService) ListRepository 

func (d *DocSearchService) ListRepository(_ context.Context, req *RequestListRepository) (*ResponseListRepository, error)
func (d *DocSearchService) PageLink(_ context.Context, req *RequestPageLink) (*ResponsePageLink, error)

type FileType 

type FileType int32
const (
	FileType_FILE_TYPE_MARKDOWN FileType = 0
)

func (FileType) Descriptor 

func (FileType) Descriptor() protoreflect.EnumDescriptor

func (FileType) Enum 

func (x FileType) Enum() *FileType

func (FileType) EnumDescriptor deprecated 

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

Deprecated: Use FileType.Descriptor instead.

func (FileType) Number 

func (x FileType) Number() protoreflect.EnumNumber

func (FileType) String 

func (x FileType) String() string

func (FileType) Type 

func (FileType) Type() protoreflect.EnumType

type LinkType 

type LinkType int32
const (
	LinkType_LINK_TYPE_EXTERNAL            LinkType = 0
	LinkType_LINK_TYPE_IN_REPOSITORY       LinkType = 1
	LinkType_LINK_TYPE_NEIGHBOR_REPOSITORY LinkType = 2
)

func (LinkType) Descriptor 

func (LinkType) Descriptor() protoreflect.EnumDescriptor

func (LinkType) Enum 

func (x LinkType) Enum() *LinkType

func (LinkType) EnumDescriptor deprecated 

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

Deprecated: Use LinkType.Descriptor instead.

func (LinkType) Number 

func (x LinkType) Number() protoreflect.EnumNumber

func (LinkType) String 

func (x LinkType) String() string

func (LinkType) Type 

func (LinkType) Type() protoreflect.EnumType

type ObjectStorageInterface 

type ObjectStorageInterface interface {
	PutReader(ctx context.Context, name string, data io.Reader) error
	Delete(ctx context.Context, name string) error
	Get(ctx context.Context, name string) (*storage.Object, error)
	List(ctx context.Context, prefix string) ([]*storage.Object, error)
}
type PageLink struct {
	Type        LinkType `protobuf:"varint,1,opt,name=type,proto3,enum=mono.docutil.LinkType" json:"type,omitempty"`
	Source      string   `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	Destination string   `protobuf:"bytes,3,opt,name=destination,proto3" json:"destination,omitempty"`
	Repository  string   `protobuf:"bytes,4,opt,name=repository,proto3" json:"repository,omitempty"`
	Title       string   `protobuf:"bytes,5,opt,name=title,proto3" json:"title,omitempty"`
	// contains filtered or unexported fields
}

func (*PageLink) Descriptor deprecated 

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

Deprecated: Use PageLink.ProtoReflect.Descriptor instead.

func (*PageLink) GetDestination 

func (x *PageLink) GetDestination() string

func (*PageLink) GetRepository 

func (x *PageLink) GetRepository() string

func (*PageLink) GetSource 

func (x *PageLink) GetSource() string

func (*PageLink) GetTitle 

func (x *PageLink) GetTitle() string

func (*PageLink) GetType 

func (x *PageLink) GetType() LinkType

func (*PageLink) ProtoMessage 

func (*PageLink) ProtoMessage()

func (*PageLink) ProtoReflect 

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

func (*PageLink) Reset 

func (x *PageLink) Reset()

func (*PageLink) String 

func (x *PageLink) String() string

type Repository 

type Repository struct {
	Name          string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	DefaultBranch string `protobuf:"bytes,2,opt,name=default_branch,json=defaultBranch,proto3" json:"default_branch,omitempty"`
	// contains filtered or unexported fields
}

func (*Repository) Descriptor deprecated 

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

Deprecated: Use Repository.ProtoReflect.Descriptor instead.

func (*Repository) GetDefaultBranch 

func (x *Repository) GetDefaultBranch() string

func (*Repository) GetName 

func (x *Repository) GetName() string

func (*Repository) ProtoMessage 

func (*Repository) ProtoMessage()

func (*Repository) ProtoReflect 

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

func (*Repository) Reset 

func (x *Repository) Reset()

func (*Repository) String 

func (x *Repository) String() string

type RequestAvailableFeatures 

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

func (*RequestAvailableFeatures) Descriptor deprecated 

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

Deprecated: Use RequestAvailableFeatures.ProtoReflect.Descriptor instead.

func (*RequestAvailableFeatures) ProtoMessage 

func (*RequestAvailableFeatures) ProtoMessage()

func (*RequestAvailableFeatures) ProtoReflect 

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

func (*RequestAvailableFeatures) Reset 

func (x *RequestAvailableFeatures) Reset()

func (*RequestAvailableFeatures) String 

func (x *RequestAvailableFeatures) String() string

type RequestGetDirectory 

type RequestGetDirectory struct {
	Repo string `protobuf:"bytes,1,opt,name=repo,proto3" json:"repo,omitempty"`
	Ref  string `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*RequestGetDirectory) Descriptor deprecated 

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

Deprecated: Use RequestGetDirectory.ProtoReflect.Descriptor instead.

func (*RequestGetDirectory) GetPath 

func (x *RequestGetDirectory) GetPath() string

func (*RequestGetDirectory) GetRef 

func (x *RequestGetDirectory) GetRef() string

func (*RequestGetDirectory) GetRepo 

func (x *RequestGetDirectory) GetRepo() string

func (*RequestGetDirectory) ProtoMessage 

func (*RequestGetDirectory) ProtoMessage()

func (*RequestGetDirectory) ProtoReflect 

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

func (*RequestGetDirectory) Reset 

func (x *RequestGetDirectory) Reset()

func (*RequestGetDirectory) String 

func (x *RequestGetDirectory) String() string

type RequestGetPage 

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

func (*RequestGetPage) Descriptor deprecated 

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

Deprecated: Use RequestGetPage.ProtoReflect.Descriptor instead.

func (*RequestGetPage) GetPath 

func (x *RequestGetPage) GetPath() string

func (*RequestGetPage) GetRepo 

func (x *RequestGetPage) GetRepo() string

func (*RequestGetPage) ProtoMessage 

func (*RequestGetPage) ProtoMessage()

func (*RequestGetPage) ProtoReflect 

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

func (*RequestGetPage) Reset 

func (x *RequestGetPage) Reset()

func (*RequestGetPage) String 

func (x *RequestGetPage) String() string

type RequestGetRepository 

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

func (*RequestGetRepository) Descriptor deprecated 

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

Deprecated: Use RequestGetRepository.ProtoReflect.Descriptor instead.

func (*RequestGetRepository) GetRepo 

func (x *RequestGetRepository) GetRepo() string

func (*RequestGetRepository) ProtoMessage 

func (*RequestGetRepository) ProtoMessage()

func (*RequestGetRepository) ProtoReflect 

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

func (*RequestGetRepository) Reset 

func (x *RequestGetRepository) Reset()

func (*RequestGetRepository) String 

func (x *RequestGetRepository) String() string

type RequestListRepository 

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

func (*RequestListRepository) Descriptor deprecated 

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

Deprecated: Use RequestListRepository.ProtoReflect.Descriptor instead.

func (*RequestListRepository) ProtoMessage 

func (*RequestListRepository) ProtoMessage()

func (*RequestListRepository) ProtoReflect 

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

func (*RequestListRepository) Reset 

func (x *RequestListRepository) Reset()

func (*RequestListRepository) String 

func (x *RequestListRepository) String() string
type RequestPageLink struct {
	Repo string `protobuf:"bytes,1,opt,name=repo,proto3" json:"repo,omitempty"`
	Sha  string `protobuf:"bytes,2,opt,name=sha,proto3" json:"sha,omitempty"`
	// contains filtered or unexported fields
}

func (*RequestPageLink) Descriptor deprecated 

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

Deprecated: Use RequestPageLink.ProtoReflect.Descriptor instead.

func (*RequestPageLink) GetRepo 

func (x *RequestPageLink) GetRepo() string

func (*RequestPageLink) GetSha 

func (x *RequestPageLink) GetSha() string

func (*RequestPageLink) ProtoMessage 

func (*RequestPageLink) ProtoMessage()

func (*RequestPageLink) ProtoReflect 

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

func (*RequestPageLink) Reset 

func (x *RequestPageLink) Reset()

func (*RequestPageLink) String 

func (x *RequestPageLink) String() string

type ResponseAvailableFeatures 

type ResponseAvailableFeatures struct {
	PageLink          bool       `protobuf:"varint,1,opt,name=page_link,json=pageLink,proto3" json:"page_link,omitempty"`
	FullTextSearch    bool       `protobuf:"varint,2,opt,name=full_text_search,json=fullTextSearch,proto3" json:"full_text_search,omitempty"`
	SupportedFileType []FileType `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ResponseAvailableFeatures) Descriptor deprecated 

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

Deprecated: Use ResponseAvailableFeatures.ProtoReflect.Descriptor instead.

func (*ResponseAvailableFeatures) GetFullTextSearch 

func (x *ResponseAvailableFeatures) GetFullTextSearch() bool
func (x *ResponseAvailableFeatures) GetPageLink() bool

func (*ResponseAvailableFeatures) GetSupportedFileType 

func (x *ResponseAvailableFeatures) GetSupportedFileType() []FileType

func (*ResponseAvailableFeatures) ProtoMessage 

func (*ResponseAvailableFeatures) ProtoMessage()

func (*ResponseAvailableFeatures) ProtoReflect 

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

func (*ResponseAvailableFeatures) Reset 

func (x *ResponseAvailableFeatures) Reset()

func (*ResponseAvailableFeatures) String 

func (x *ResponseAvailableFeatures) String() string

type ResponseGetDirectory 

type ResponseGetDirectory struct {
	Entries []*DirectoryEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

func (*ResponseGetDirectory) Descriptor deprecated 

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

Deprecated: Use ResponseGetDirectory.ProtoReflect.Descriptor instead.

func (*ResponseGetDirectory) GetEntries 

func (x *ResponseGetDirectory) GetEntries() []*DirectoryEntry

func (*ResponseGetDirectory) ProtoMessage 

func (*ResponseGetDirectory) ProtoMessage()

func (*ResponseGetDirectory) ProtoReflect 

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

func (*ResponseGetDirectory) Reset 

func (x *ResponseGetDirectory) Reset()

func (*ResponseGetDirectory) String 

func (x *ResponseGetDirectory) String() string

type ResponseGetPage 

type ResponseGetPage struct {
	Title   string      `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	Doc     string      `protobuf:"bytes,2,opt,name=doc,proto3" json:"doc,omitempty"`
	In      []*PageLink `protobuf:"bytes,3,rep,name=in,proto3" json:"in,omitempty"`
	Out     []*PageLink `protobuf:"bytes,4,rep,name=out,proto3" json:"out,omitempty"`
	RawUrl  string      `protobuf:"bytes,5,opt,name=raw_url,json=rawUrl,proto3" json:"raw_url,omitempty"`
	EditUrl string      `protobuf:"bytes,6,opt,name=edit_url,json=editUrl,proto3" json:"edit_url,omitempty"`
	// contains filtered or unexported fields
}

func (*ResponseGetPage) Descriptor deprecated 

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

Deprecated: Use ResponseGetPage.ProtoReflect.Descriptor instead.

func (*ResponseGetPage) GetDoc 

func (x *ResponseGetPage) GetDoc() string

func (*ResponseGetPage) GetEditUrl 

func (x *ResponseGetPage) GetEditUrl() string

func (*ResponseGetPage) GetIn 

func (x *ResponseGetPage) GetIn() []*PageLink

func (*ResponseGetPage) GetOut 

func (x *ResponseGetPage) GetOut() []*PageLink

func (*ResponseGetPage) GetRawUrl 

func (x *ResponseGetPage) GetRawUrl() string

func (*ResponseGetPage) GetTitle 

func (x *ResponseGetPage) GetTitle() string

func (*ResponseGetPage) ProtoMessage 

func (*ResponseGetPage) ProtoMessage()

func (*ResponseGetPage) ProtoReflect 

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

func (*ResponseGetPage) Reset 

func (x *ResponseGetPage) Reset()

func (*ResponseGetPage) String 

func (x *ResponseGetPage) String() string

type ResponseGetRepository 

type ResponseGetRepository struct {
	Repository *Repository `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
	// contains filtered or unexported fields
}

func (*ResponseGetRepository) Descriptor deprecated 

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

Deprecated: Use ResponseGetRepository.ProtoReflect.Descriptor instead.

func (*ResponseGetRepository) GetRepository 

func (x *ResponseGetRepository) GetRepository() *Repository

func (*ResponseGetRepository) ProtoMessage 

func (*ResponseGetRepository) ProtoMessage()

func (*ResponseGetRepository) ProtoReflect 

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

func (*ResponseGetRepository) Reset 

func (x *ResponseGetRepository) Reset()

func (*ResponseGetRepository) String 

func (x *ResponseGetRepository) String() string

type ResponseListRepository 

type ResponseListRepository struct {
	Repositories []*Repository `protobuf:"bytes,1,rep,name=repositories,proto3" json:"repositories,omitempty"`
	// contains filtered or unexported fields
}

func (*ResponseListRepository) Descriptor deprecated 

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

Deprecated: Use ResponseListRepository.ProtoReflect.Descriptor instead.

func (*ResponseListRepository) GetRepositories 

func (x *ResponseListRepository) GetRepositories() []*Repository

func (*ResponseListRepository) ProtoMessage 

func (*ResponseListRepository) ProtoMessage()

func (*ResponseListRepository) ProtoReflect 

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

func (*ResponseListRepository) Reset 

func (x *ResponseListRepository) Reset()

func (*ResponseListRepository) String 

func (x *ResponseListRepository) String() string
type ResponsePageLink struct {
	In  []*PageLink `protobuf:"bytes,1,rep,name=in,proto3" json:"in,omitempty"`
	Out []*PageLink `protobuf:"bytes,2,rep,name=out,proto3" json:"out,omitempty"`
	// contains filtered or unexported fields
}

func (*ResponsePageLink) Descriptor deprecated 

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

Deprecated: Use ResponsePageLink.ProtoReflect.Descriptor instead.

func (*ResponsePageLink) GetIn 

func (x *ResponsePageLink) GetIn() []*PageLink

func (*ResponsePageLink) GetOut 

func (x *ResponsePageLink) GetOut() []*PageLink

func (*ResponsePageLink) ProtoMessage 

func (*ResponsePageLink) ProtoMessage()

func (*ResponsePageLink) ProtoReflect 

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

func (*ResponsePageLink) Reset 

func (x *ResponsePageLink) Reset()

func (*ResponsePageLink) String 

func (x *ResponsePageLink) String() string

type UnimplementedDocSearchServer 

type UnimplementedDocSearchServer struct {
}

UnimplementedDocSearchServer can be embedded to have forward compatible implementations.

func (*UnimplementedDocSearchServer) AvailableFeatures 

func (*UnimplementedDocSearchServer) AvailableFeatures(context.Context, *RequestAvailableFeatures) (*ResponseAvailableFeatures, error)

func (*UnimplementedDocSearchServer) GetDirectory 

func (*UnimplementedDocSearchServer) GetDirectory(context.Context, *RequestGetDirectory) (*ResponseGetDirectory, error)

func (*UnimplementedDocSearchServer) GetPage 

func (*UnimplementedDocSearchServer) GetPage(context.Context, *RequestGetPage) (*ResponseGetPage, error)

func (*UnimplementedDocSearchServer) GetRepository 

func (*UnimplementedDocSearchServer) GetRepository(context.Context, *RequestGetRepository) (*ResponseGetRepository, error)

func (*UnimplementedDocSearchServer) ListRepository 

func (*UnimplementedDocSearchServer) ListRepository(context.Context, *RequestListRepository) (*ResponseListRepository, error)
func (*UnimplementedDocSearchServer) PageLink(context.Context, *RequestPageLink) (*ResponsePageLink, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.