writer

Documentation

Overview

Copyright 2023 FishGoddess. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type BatchWriter
  • func Batch(writer io.Writer, batchSize uint64) *BatchWriter
  • func (bw *BatchWriter) Close() error
  • func (bw *BatchWriter) Sync() error
  • func (bw *BatchWriter) Write(p []byte) (n int, err error)
• type BufferWriter
  • func Buffer(writer io.Writer, bufferSize uint64) *BufferWriter
  • func (bw *BufferWriter) Close() error
  • func (bw *BufferWriter) Sync() error
  • func (bw *BufferWriter) Write(p []byte) (n int, err error)

Types

type BatchWriter

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

BatchWriter is a writer having a buffer inside to reduce times of writing underlying writer.

func Batch

func Batch(writer io.Writer, batchSize uint64) *BatchWriter

Batch returns a new batch writer of writer with specified batchSize. Notice that batchSize must be larger than minBatchSize or a panic will happen. See minBatchSize.

func (*BatchWriter) Close

func (bw *BatchWriter) Close() error

Close syncs data and closes underlying writer if writer implements io.Closer.

func (*BatchWriter) Sync

func (bw *BatchWriter) Sync() error

Sync writes data in buffer to underlying writer if buffer has data. It's safe in concurrency.

func (*BatchWriter) Write

func (bw *BatchWriter) Write(p []byte) (n int, err error)

Write writes p to buffer and syncs data to underlying writer first if it needs.

type BufferWriter

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

BufferWriter is a writer having a buffer inside to reduce times of writing underlying writer.

func Buffer

func Buffer(writer io.Writer, bufferSize uint64) *BufferWriter

Buffer returns a new buffer writer of writer with specified bufferSize. Notice that bufferSize must be larger than minBufferSize or a panic will happen. See minBufferSize.

func (*BufferWriter) Close

func (bw *BufferWriter) Close() error

Close syncs data and closes underlying writer if writer implements io.Closer.

func (*BufferWriter) Sync

func (bw *BufferWriter) Sync() error

Sync writes data in buffer to underlying writer if buffer has data. It's safe in concurrency.

func (*BufferWriter) Write

func (bw *BufferWriter) Write(p []byte) (n int, err error)

Write writes p to buffer and syncs data to underlying writer first if it needs.