github.com/vescale/zgraph@v0.0.0-20230410094002-959c02d50f95/catalog/index.go (about)

     1  // Copyright 2022 zGraph Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package catalog
    16  
    17  import "github.com/vescale/zgraph/parser/model"
    18  
    19  // Index represents a runtime index object.
    20  type Index struct {
    21  	meta *model.IndexInfo
    22  }
    23  
    24  // NewIndex returns a new index object.
    25  func NewIndex(meta *model.IndexInfo) *Index {
    26  	return &Index{
    27  		meta: meta,
    28  	}
    29  }
    30  
    31  // Meta returns the meta information object of this index.
    32  func (i *Index) Meta() *model.IndexInfo {
    33  	return i.meta
    34  }