github.com/timstclair/heapster@v0.20.0-alpha1/Godeps/_workspace/src/k8s.io/kubernetes/pkg/conversion/doc.go (about)

     1  /*
     2  Copyright 2014 The Kubernetes Authors All rights reserved.
     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  
    17  // Package conversion provides go object versioning and encoding/decoding
    18  // mechanisms.
    19  //
    20  // Specifically, conversion provides a way for you to define multiple versions
    21  // of the same object. You may write functions which implement conversion logic,
    22  // but for the fields which did not change, copying is automated. This makes it
    23  // easy to modify the structures you use in memory without affecting the format
    24  // you store on disk or respond to in your external API calls.
    25  //
    26  // The second offering of this package is automated encoding/decoding. The version
    27  // and type of the object is recorded in the output, so it can be recreated upon
    28  // reading. Currently, conversion writes JSON output, and interprets both JSON
    29  // and YAML input.
    30  //
    31  package conversion