github.com/cloudwego/hertz@v0.9.3/pkg/app/server/render/protobuf.go (about)

     1  /*
     2   * Copyright 2022 CloudWeGo Authors
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *  http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   *
    16   * The MIT License (MIT)
    17   *
    18   * Copyright (c) 2014 Manuel Martínez-Almeida
    19   *
    20   * Permission is hereby granted, free of charge, to any person obtaining a copy
    21   * of this software and associated documentation files (the "Software"), to deal
    22   * in the Software without restriction, including without limitation the rights
    23   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    24   * copies of the Software, and to permit persons to whom the Software is
    25   * furnished to do so, subject to the following conditions:
    26   *
    27   * The above copyright notice and this permission notice shall be included in
    28   * all copies or substantial portions of the Software.
    29   *
    30   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    31   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    32   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    33   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    34   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    35   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    36   * THE SOFTWARE.
    37  
    38   * This file may have been modified by CloudWeGo authors. All CloudWeGo
    39   * Modifications are Copyright 2022 CloudWeGo Authors.
    40   */
    41  
    42  package render
    43  
    44  import (
    45  	"github.com/cloudwego/hertz/pkg/protocol"
    46  	"google.golang.org/protobuf/proto"
    47  )
    48  
    49  // ProtoBuf contains the given interface object.
    50  type ProtoBuf struct {
    51  	Data interface{}
    52  }
    53  
    54  var protobufContentType = "application/x-protobuf"
    55  
    56  // Render (ProtoBuf) marshals the given interface object and writes data with custom ContentType.
    57  func (r ProtoBuf) Render(resp *protocol.Response) error {
    58  	r.WriteContentType(resp)
    59  	bytes, err := proto.Marshal(r.Data.(proto.Message))
    60  	if err != nil {
    61  		return err
    62  	}
    63  
    64  	resp.AppendBody(bytes)
    65  	return nil
    66  }
    67  
    68  // WriteContentType (ProtoBuf) writes ProtoBuf ContentType.
    69  func (r ProtoBuf) WriteContentType(resp *protocol.Response) {
    70  	writeContentType(resp, protobufContentType)
    71  }