go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/data/recordio/doc.go (about)

     1  // Copyright 2015 The LUCI Authors.
     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 recordio implements a basic RecordIO reader and writer.
    16  //
    17  // Each RecordIO frame begins with a Uvarint (
    18  // http://golang.org/pkg/encoding/binary/#Uvarint) containing the size of the
    19  // frame, followed by that many bytes of frame data.
    20  //
    21  // The frame protocol does not handle data integrity; that is left to the
    22  // outer protocol or medium which uses the frame.
    23  package recordio